├── Classes ├── extNodeProxy.sc ├── SystemOverwrites │ ├── extSpec.sc │ ├── extMonitor.sc │ └── extBusPlug.sc └── NodeProxyGui2.sc ├── NodeProxyGui2.quark ├── todo.md ├── HelpSource └── Classes │ ├── NodeProxy.ext.schelp │ └── NodeProxyGui2.schelp ├── README.md └── LICENSE.md /Classes/extNodeProxy.sc: -------------------------------------------------------------------------------- 1 | + NodeProxy { 2 | 3 | gui2 { | limitUpdateRate = 0, show = true, collapseArrays = false | 4 | ^NodeProxyGui2.new(this, limitUpdateRate, show, collapseArrays) 5 | } 6 | 7 | } 8 | -------------------------------------------------------------------------------- /Classes/SystemOverwrites/extSpec.sc: -------------------------------------------------------------------------------- 1 | + Spec { 2 | 3 | *add { | name, args | 4 | var spec = args.asSpec; 5 | specs.put(name, spec); 6 | this.changed(\add, [name, spec]); 7 | ^spec 8 | } 9 | 10 | } 11 | -------------------------------------------------------------------------------- /Classes/SystemOverwrites/extMonitor.sc: -------------------------------------------------------------------------------- 1 | + Monitor { 2 | 3 | vol_ { | val | 4 | if(val == vol) { ^this }; 5 | vol = val; 6 | if(this.isPlaying) { group.set(\vol, val) }; 7 | this.changed(\vol, [val]); 8 | } 9 | 10 | } 11 | -------------------------------------------------------------------------------- /Classes/SystemOverwrites/extBusPlug.sc: -------------------------------------------------------------------------------- 1 | + BusPlug { 2 | 3 | initMonitor { | vol | 4 | if(monitor.isNil) { 5 | monitor = Monitor.new; 6 | this.changed(\monitor); 7 | }; 8 | if (vol.notNil) { monitor.vol_(vol) }; 9 | ^monitor 10 | } 11 | 12 | } 13 | -------------------------------------------------------------------------------- /NodeProxyGui2.quark: -------------------------------------------------------------------------------- 1 | ( 2 | name: "nodeproxygui2", 3 | summary: "A modern alternative to the NodeProxy gui", 4 | version: "1.1.5", 5 | schelp: "NodeProxyGui2", 6 | dependencies: [], 7 | license: "GNU GPL v3.0", 8 | copyright: "Mads Kjeldgaard, Fredrik Olofsson, Niklas Adam", 9 | ext_dependency: "", 10 | url: "https://github.com/madskjeldgaard/nodeproxygui2" 11 | ) 12 | -------------------------------------------------------------------------------- /todo.md: -------------------------------------------------------------------------------- 1 | # TODO 2 | 3 | ## Improvements 4 | - Slider placement for "vol" (default + dynamic?) 5 | - Minimize function (or gui3) 6 | 7 | ## Bugs 8 | - PopUp stays open when tabbing away from sc application (bug in scqt) **MacOs** 9 | - Minor resize problem when setting a Buffer after the fact. 10 | 11 | ## Features 12 | - Make A/B buttons to allow A/B testing two different parameter sets 13 | - Add pause/resume andOr mute/solo 14 | - Presets - store and recall 15 | - Add skin/palette selector 16 | - Drag and drop values between `NumberBoxes` 17 | - Drag and drop NodeProxies to NumberBoxes internally and externally between guis, 18 | 19 | ## Ideas 20 | - add mute / solo button (used instead of Ndef.pause,-.resume) 21 | -------------------------------------------------------------------------------- /HelpSource/Classes/NodeProxy.ext.schelp: -------------------------------------------------------------------------------- 1 | INSTANCEMETHODS:: 2 | 3 | SUBSECTION:: Extensions by NodeProxyGui2 quark 4 | 5 | METHOD:: gui2 6 | Creates a GUI for this NodeProxy. Shortcut for CODE::NodeProxyGui2.new(thisNodeProxy):: 7 | 8 | ARGUMENT:: limitUpdateRate 9 | The higher this value, the slower the interface will update. In seconds. Default is CODE::0:: which mean instant updates. 10 | 11 | ARGUMENT:: show 12 | If CODE::false::, don't display the window immediately, so that it can be 13 | embedded in other GUIs. Default is CODE::true::. 14 | 15 | ARGUMENT:: collapseArray 16 | When CODE::true::, arrays of parameters will be shown as single line LINK::Classes/TextField::s. The default (CODE::false::) will show arrays of parameters as separate silders. 17 | 18 | RETURNS:: a LINK::Classes/NodeProxyGui2:: instance. 19 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # NodeProxyGui2 2 | 3 | ![ndefgui2 in action](https://oddodd.org/git-readme-assets/ndefgui2.gif) 4 | 5 | An alternative to SuperCollider's built-in (and partly broken) Ndef.gui method. 6 | 7 | Usage is very simple. Instead of calling `gui` on a nodeproxy object you simply call `gui2`: 8 | ```supercollider 9 | ( 10 | Ndef(\abc, {|freq=100, amp=0.5, pan=0| 11 | Pan2.ar(SinOsc.ar(freq), pos: pan, level: amp) 12 | }); 13 | ) 14 | 15 | g = Ndef(\abc).gui2; 16 | g.close; 17 | 18 | // dont randomize/vary ignored parameters 19 | NodeProxyGui2.defaultIgnoreParams_([\amp, "freq*", "*[fF]eedback\\b"]) // wildcard (regex) args 20 | 21 | ( 22 | f = 9; 23 | Ndef('ignore', { 24 | var a = [\a.kr(0.5), \aa.kr(1/3)]; 25 | var t1 = \a_thing.kr(100), s2 = \a_nother_thing_y.kr(200); 26 | var freqs = f.collect{|n|n=n+1;("freq"++(n)).asSymbol.kr(100*n)}; 27 | Splay.ar(SinOscFB.ar(freqs, \sinFeedback.kr(1/5), mul:'amp'.kr(0.1))); 28 | }); 29 | f.do{|n| 30 | n=n+1; 31 | Spec.add(("freq"++(n)).asSymbol.postln, ControlSpec( 100.0, 14000.0, \exp, 0, 50, "Hz") ); 32 | }; 33 | g = Ndef('ignore').gui2; 34 | g.ignoreParams = ["a", "*thing.*"]; // note .* 35 | ) 36 | 37 | g.randomize; 38 | g.vary; 39 | ``` 40 | 41 | ## Design goals 42 | 43 | The reason for this package's existence is to experiment with fixing some issues that are currently in the built in NodeProxy GUI for SuperCollider. These aren't all fixed, but include: 44 | 45 | * User scaleable layout – have GUI elements resize with window size. 46 | * Readable text and values – the font size should be readable on modern screens, and labels should not overflow 47 | * Add small extra features like allowing parameters to be randomized 48 | * Use sensible defaults for parameter Specs – if no Spec is defined with the NodeProxy, it should fall back to `[0.0, 1.0, \lin].asSpec` and not some random guess. Also, use a search hierarchy: Look in the NodeProxies specs, then in the global `ControlSpec.specs` and if both those fails, fall back to a default. 49 | * A neutral look and feel. It shouldn't try to be clever with colors, unless necessary. 50 | 51 | ## Installation 52 | 53 | Open up SuperCollider and evaluate the following line of code: 54 | `Quarks.install("https://github.com/madskjeldgaard/nodeproxygui2")` 55 | -------------------------------------------------------------------------------- /HelpSource/Classes/NodeProxyGui2.schelp: -------------------------------------------------------------------------------- 1 | TITLE:: NodeProxyGui2 2 | SUMMARY:: Providing a modern alternative to the NodeProxy GUI 3 | CATEGORIES:: JITLib>GUI 4 | RELATED:: Classes/NdefGui, Classes/NdefParamGui, Classes/NodeProxy 5 | 6 | 7 | DESCRIPTION:: 8 | 9 | NodeProxyGui2 is a modernized alternative to the classic NodeProxy / Ndef GUI 10 | available in SuperCollider. It fixes a number of problems with the old GUI, 11 | improves some things and adds a few handy new features to its set. 12 | 13 | The main motivation behind it is to create a GUI that is: 14 | 15 | LIST:: 16 | ## Readable (labels have a readable font size on modern displays and do not get 17 | EMPHASIS::cut off:: if overflowing because of long names) 18 | ## Has a tight integration with local and global LINK::Classes/ControlSpec::s, 19 | and if no spec is found for a parameter, it has a reasonable fallback (assuming 20 | it is a parameter with the range 0.0 to 1.0) 21 | ## Has user scaleable layout – GUI elements resize with window size. 22 | :: 23 | 24 | 25 | CLASSMETHODS:: 26 | 27 | METHOD:: new 28 | 29 | ARGUMENT:: nodeproxy 30 | An LINK::Classes/NodeProxy:: instance. 31 | 32 | ARGUMENT:: limitUpdateRate 33 | The higher this value, the slower the interface will update. In seconds. Default is CODE::0:: which mean instant updates. 34 | 35 | ARGUMENT:: show 36 | If CODE::false::, don't display the window immediately, so that it can be 37 | embedded in other GUIs. Default is CODE::true::. 38 | 39 | ARGUMENT:: collapseArrays 40 | When CODE::true::, arrays of parameters will be shown as single line LINK::Classes/TextField::s. The default (CODE::false::) will show arrays of parameters as separate silders. 41 | 42 | DISCUSSION:: 43 | A non-zero limitUpdateRate will reduce the CPU cost of updating GUI elements. If there are many parameters continuously updated - say from a bunch of noisy sensor readings, a reasonable limit is CODE::0.1::. That will force the GUI elements to only redraw ten times per second. CODE::0.1:: is also what the standard LINK::Classes/NdefGui:: uses internally. The limitUpdateRate can also be specified as an argument to the LINK::Classes/NodeProxy#-gui2:: method. 44 | 45 | METHOD:: defaultExcludeParams 46 | Parameters to be excluded. No GUI widgets will be created for these parameters. Expects an LINK::Classes/Array:: of symbols or strings. Wildcards (*) and Perl Regular Expression Syntax .[{}()\*+?|^$ are supported. 47 | 48 | METHOD:: defaultIgnoreParams 49 | Parameters to be ignored when calling LINK::#-randomize::, LINK::#-vary:: or LINK::#-defaults::. Expects an LINK::Classes/Array:: of symbols or strings. Wildcards (*) and Perl Regular Expression Syntax .[{}()\*+?|^$ are supported. 50 | 51 | CODE:: 52 | NodeProxyGui2.defaultIgnoreParams = ["freq*", "^[Ff]eedback.*", "*[Gg]ain\\b" \pan]; 53 | :: 54 | 55 | 56 | INSTANCEMETHODS:: 57 | 58 | PRIVATE:: init, initFonts, makeInfoSection, makeTransportSection, makeParameterSection, makeParameterViews, nodeProxyChanged, parameterChanged, setUpDependencies, filteredParams, filteredParamsDo, paramPresentInArray 59 | 60 | METHOD:: nodeProxy 61 | Access the LINK::Classes/NodeProxy:: / LINK::Classes/Ndef:: belonging to this GUI. 62 | 63 | METHOD:: ndef 64 | Alias for LINK::#-nodeProxy:: 65 | 66 | METHOD:: excludeParams 67 | Get or set the parameters to be excluded. No GUI widgets will be created for these parameters. Expects an LINK::Classes/Array:: of symbols or strings. Wildcards (*) are supported. 68 | 69 | METHOD:: ignoreParams 70 | Get or set the parameters to be ignored when calling LINK::#-randomize::, LINK::#-vary:: or LINK::#-defaults:: on this instance. Expects an LINK::Classes/Array:: of symbols or strings. Wildcards (*) are supported. 71 | 72 | METHOD:: randomize 73 | Set parameters to random values. 74 | NOTE::Parameters listed in either LINK::#-ignoreParams:: or in LINK::#*defaultIgnoreParams:: will be excluded.:: 75 | 76 | ARGUMENT:: randmin 77 | A normalized LINK::Classes/Float::. 78 | 79 | ARGUMENT:: randmax 80 | A normalized LINK::Classes/Float::. 81 | 82 | METHOD:: vary 83 | Set parameters to nearby random values - gaussian distribution. 84 | NOTE::Parameters listed in either LINK::#-ignoreParams:: or in LINK::#*defaultIgnoreParams:: will be excluded.:: 85 | 86 | ARGUMENT:: deviation 87 | A normalized LINK::Classes/Float::. 88 | 89 | METHOD:: defaults 90 | Set parameters to LINK::Classes/ControlSpec:: default values. Specs are first looked up in the node proxy's spec, and then in CODE::Spec.specs::. 91 | NOTE::Parameters listed in either LINK::#-ignoreParams:: or in LINK::#*defaultIgnoreParams:: will be excluded.:: 92 | 93 | METHOD:: close 94 | Closes the window. 95 | 96 | METHOD:: window 97 | Get the LINK::Classes/Window:: instance. 98 | 99 | METHOD:: asCode 100 | The node with its current settings represented as code. This can be useful for presets / snapshots. 101 | 102 | NOTE:: 103 | LINK::#-ignoreParams:: are included while LINK::#-excludeParams:: not. 104 | :: 105 | 106 | ARGUMENT:: includeMonitor 107 | A LINK::Classes/Boolean:: value that specifies whether or not a .play line should be included (assuming the node is playing). 108 | 109 | ARGUMENT:: envir 110 | An optional LINK::Classes/Environment:: like a LINK::Classes/ProxySpace::. 111 | 112 | RETURNS:: A LINK::Classes/String:: containing code that recreates the node and its current settings. 113 | 114 | METHOD:: document 115 | Creates a new document with code (using LINK::#-asCode::) that recreates this node with its current settings. 116 | 117 | ARGUMENT:: includeMonitor 118 | A LINK::Classes/Boolean:: value that specifies whether or not a .play line should be included (assuming the node is playing). 119 | 120 | EXAMPLES:: 121 | 122 | CODE:: 123 | ( 124 | Ndef(\yiyi, {|freq=300, amp=0.5, pan=0| 125 | Pan2.ar(SinOsc.ar(freq), pos: pan, level: amp) 126 | }); 127 | ) 128 | 129 | // .gui2 returns the GUI, allowing you to further manipulate it later on, or simply close it 130 | g = Ndef(\yiyi).gui2; 131 | 132 | g.randomize; 133 | 134 | // don't randomize excluded parameters 135 | g.ignoreParams = [\amp]; 136 | g.randomize; 137 | 138 | // Close the GUI 139 | g.close(); 140 | 141 | // With show = false, the GUI is embeddable in larger views 142 | ( 143 | var win = Window("two guis in the same window"); 144 | Ndef(\yoyo, {|freq=300, amp=0.5, pan=0| 145 | Pan2.ar(VarSaw.ar(freq), pos: pan, level: amp) 146 | }); 147 | win.view.layout = HLayout( 148 | NodeProxyGui2(Ndef(\yiyi), show: false), 149 | NodeProxyGui2(Ndef(\yoyo), show: false) 150 | ); 151 | win.front; 152 | ) 153 | 154 | ( 155 | var win = Window("an ndef and something else"); 156 | var graphics = UserView().drawFunc_({ |v| 157 | {:Rect(x,y,20.rand,20.rand), 158 | x <- (0,20..v.bounds.width), y <- (0,20..v.bounds.height) 159 | }.do { |r| 160 | Pen.fillColor_(Color.rand).fillOval(r) 161 | } 162 | }); 163 | win.view.layout = VLayout( 164 | [graphics, s: 2], 165 | NodeProxyGui2(Ndef(\yiyi), show: false) 166 | ); 167 | win.front 168 | ) 169 | :: 170 | -------------------------------------------------------------------------------- /Classes/NodeProxyGui2.sc: -------------------------------------------------------------------------------- 1 | NodeProxyGui2 { 2 | 3 | classvar <>defaultExcludeParams = #[]; 4 | classvar <>defaultIgnoreParams = #[]; 5 | 6 | var ignoreParams; 12 | var 0, { 75 | 76 | limitOrder = OrderedIdentitySet.new(8); 77 | limitDict = IdentityDictionary.new(); 78 | limitScheduler = SkipJack.new({ 79 | if(limitOrder.size > 0, { 80 | limitOrder.do{ | key | this.nodeProxyChanged(*limitDict[key]) }; 81 | limitOrder.clear; 82 | limitDict.clear; 83 | }); 84 | }, limitUpdateRate, clock: AppClock); 85 | { | obj ...args | 86 | var key = args[0]; 87 | if(key == \set) { 88 | args[1].pairsDo { | paramKey, v | 89 | key = (key ++ paramKey).asSymbol; 90 | limitOrder.add(key); 91 | limitDict.put(key, [\set, [paramKey, v]]); 92 | } 93 | } { 94 | limitOrder.add(key); 95 | limitDict.put(key, args); 96 | } 97 | } 98 | 99 | }, { 100 | 101 | { | obj ...args | { this.nodeProxyChanged(*args) }.defer } 102 | 103 | }); 104 | 105 | Spec.addDependant(specAddedFunc); 106 | nodeProxy.addDependant(nodeProxyChangedFunc); 107 | if(nodeProxy.monitor.notNil, { 108 | nodeProxy.monitor.addDependant(nodeProxyChangedFunc) 109 | }); 110 | 111 | window.onClose = { 112 | limitScheduler.stop; 113 | nodeProxy.monitor.removeDependant(nodeProxyChangedFunc); 114 | nodeProxy.removeDependant(nodeProxyChangedFunc); 115 | Spec.removeDependant(specAddedFunc); 116 | params.do{ | spec | spec.removeDependant(specChangedFunc) }; 117 | }; 118 | } 119 | 120 | nodeProxyChanged { | what, args | 121 | var key; 122 | 123 | case 124 | { what == \set } { 125 | key = args[0]; 126 | 127 | if(key == \fadeTime, { 128 | updateInfoFunc.value(nodeProxy) 129 | }, { 130 | args.pairsDo { | paramKey, val | 131 | if(params[paramKey].notNil, { 132 | this.parameterChanged(paramKey, val) 133 | }) 134 | } 135 | }) 136 | } 137 | { what == \vol } { 138 | if(volslider.notNil, { 139 | volvalueBox.value_(args[0].max(0.0)); 140 | volslider.value_(args[0]); 141 | }); 142 | } 143 | { what == \play or: { what == \playN } } { 144 | play.value_(1); 145 | if(nodeProxy.monitor.notNil and: { volslider.isNil }, { 146 | this.makeParameterSection() 147 | }); 148 | } 149 | { what == \monitor } { 150 | nodeProxy.monitor.addDependant(nodeProxyChangedFunc) 151 | } 152 | { what == \source } { 153 | this.makeParameterSection() 154 | } 155 | { what == \rebuild } { 156 | updateInfoFunc.value(nodeProxy); 157 | this.makeParameterSection(); 158 | } 159 | { what == \bus } { 160 | updateInfoFunc.value(nodeProxy) 161 | } 162 | { what == \clear } { 163 | updateInfoFunc.value(nodeProxy) 164 | } 165 | { what == \stop or: { what == \pause } } { 166 | play.value_(0) 167 | } 168 | { what == \resume } { 169 | play.value_(1) 170 | } 171 | { what == \unmap } { 172 | nodeProxy.getKeysValues(args).do{ | arr | 173 | this.parameterChanged(*arr) 174 | } 175 | } 176 | //{ what == \map } {} 177 | //{ what == \unset } {} 178 | //{ what == \free } {} 179 | } 180 | 181 | parameterChanged { | key, val | 182 | var spec; 183 | 184 | case 185 | { val.isNumber } { 186 | if(paramViews[key][\type] != \number, { this.makeParameterSection() }); 187 | spec = params[key].value; 188 | paramViews[key][\numBox].value_(spec.constrain(val)); 189 | paramViews[key][\slider].value_(spec.unmap(val)); 190 | } 191 | { val.isArray } { 192 | if(paramViews[key][\type] != \array, { this.makeParameterSection() }); 193 | spec = params[key].value; 194 | if(collapseArrays.not and: { val.every(_.isNumber) }, { 195 | val.do { | v, i | 196 | paramViews[key][\numBoxes].wrapAt(i).value = spec.wrapAt(i).constrain(v); 197 | paramViews[key][\sliders].wrapAt(i).value = spec.wrapAt(i).unmap(v) 198 | }; 199 | }, { 200 | paramViews[key][\textField].value_(val.collect{ | v, i | 201 | spec.wrapAt(i).constrain(v); 202 | }); 203 | }); 204 | } 205 | { val.isKindOf(Bus) } { 206 | if(paramViews[key][\type] != \bus, { this.makeParameterSection() }); 207 | paramViews[key][\numBox].value_(val.index); 208 | paramViews[key][\text].string_(val); 209 | } 210 | { val.isKindOf(Buffer) } { 211 | if(paramViews[key][\type] != \buffer, { this.makeParameterSection() }); 212 | paramViews[key][\numBox].value_(val.bufnum); 213 | paramViews[key][\text].string_(val); 214 | } 215 | { val.isKindOf(NodeProxy) } { 216 | if(paramViews[key][\type] != \proxy, { this.makeParameterSection() }); 217 | if(val.isKindOf(Ndef), { 218 | val = "% (%, %)".format(val, val.rate, val.numChannels) 219 | }); 220 | paramViews[key][\text].string_(val); 221 | } 222 | { val.isKindOf(Symbol) and: { val.asString[0] == $c or: { val.asString[0] == $a } } } { 223 | if(paramViews[key][\type] != \map, { this.makeParameterSection() }); 224 | paramViews[key][\text].string_(val); 225 | } 226 | { 227 | "% parameter '%' not set".format(this.class, key).warn; 228 | } 229 | } 230 | 231 | makeInfoSection { 232 | var fadeTime, fadeTimeLabel, channels, rate; 233 | 234 | fadeTimeLabel = StaticText.new() 235 | .string_("fadeTime:"); 236 | 237 | fadeTime = NumberBox.new() 238 | .clipLo_(0.0) 239 | .decimals_(2) 240 | .scroll_step_(0.1) // mouse 241 | .step_(0.1) // keys 242 | .action_({ | obj | 243 | nodeProxy.fadeTime = obj.value; 244 | }); 245 | 246 | channels = StaticText.new(); 247 | 248 | rate = StaticText.new(); 249 | 250 | updateInfoFunc = { | np | 251 | fadeTime.value = np.fadeTime; 252 | channels.string = "channels: %".format(np.numChannels); 253 | rate.string = "rate: %".format(np.rate); 254 | }; 255 | updateInfoFunc.value(nodeProxy); 256 | 257 | if(nodeProxy.key.notNil, { 258 | header = StaticText.new().string_(nodeProxy.key) 259 | }); 260 | 261 | ^VLayout.new( 262 | header, 263 | HLayout.new(fadeTimeLabel, [fadeTime, a: \left], channels, rate), 264 | ) 265 | } 266 | 267 | makeTransportSection { 268 | var clear, send, scope, free, popup; 269 | 270 | play = Button.new() 271 | .states_([ 272 | ["play"], 273 | ["stop", Color.black, Color.grey(0.5, 0.5)], 274 | ]) 275 | .action_({ | obj | 276 | if(obj.value == 1, { 277 | nodeProxy.play 278 | }, { 279 | nodeProxy.stop 280 | }) 281 | }) 282 | .value_(nodeProxy.isMonitoring.binaryValue); 283 | 284 | clear = Button.new() 285 | .states_(#[ 286 | ["clear"] 287 | ]) 288 | .action_({ | obj | 289 | nodeProxy.clear 290 | }); 291 | 292 | send = Button.new() 293 | .states_(#[ 294 | ["send"] 295 | ]) 296 | .action_({ | obj | 297 | nodeProxy.send 298 | }); 299 | 300 | scope = Button.new() 301 | .states_(#[ 302 | ["scope"] 303 | ]) 304 | .action_({ | obj | 305 | nodeProxy.scope 306 | }); 307 | 308 | free = Button.new() 309 | .states_(#[ 310 | ["free"] 311 | ]) 312 | .action_({ | obj | 313 | nodeProxy.free 314 | }); 315 | 316 | popup = PopUpMenu.new() 317 | .allowsReselection_(true) 318 | .items_(#[ 319 | "defaults", 320 | "randomize parameters", 321 | "vary parameters", 322 | "document", 323 | "post", 324 | ]) 325 | .action_({ | obj | 326 | switch(obj.value, 327 | 0, { this.defaults() }, 328 | 1, { this.randomize() }, 329 | 2, { this.vary() }, 330 | 3, { this.document }, 331 | 4, { this.asCode.postln }, 332 | ) 333 | }) 334 | .keyDownAction_({ | obj, char | 335 | if(char == Char.ret, { 336 | obj.doAction 337 | }) 338 | }) 339 | .canFocus_(true) 340 | .fixedWidth_(25); 341 | 342 | ^HLayout.new( 343 | play, clear, free, scope, send, popup 344 | ) 345 | } 346 | 347 | makeParameterSection { 348 | var excluded = defaultExcludeParams ++ prExcludeParams; 349 | var numParams = params.flatSize; 350 | var sectionSize; 351 | 352 | params.do{ | spec | spec.removeDependant(specChangedFunc) }; 353 | params.clear; 354 | 355 | nodeProxy.controlKeysValues.pairsDo{ | key, val | 356 | var spec; 357 | 358 | if(this.paramPresentInArray(key, excluded).not, { 359 | 360 | spec = case 361 | { val.isNumber } { 362 | (nodeProxy.specs.at(key) ?? { Spec.specs.at(key) }).asSpec 363 | } 364 | { val.isArray } { 365 | (nodeProxy.specs.at(key) ?? { Spec.specs.at(key) }).asSpec.dup(val.size) 366 | } 367 | { val.isKindOf(Bus) } { 368 | if(val.rate == \control, { \controlbus }, { \audiobus }).asSpec 369 | } 370 | { val.isKindOf(Buffer) } { 371 | ControlSpec.new(0, Server.default.options.numBuffers - 1, 'lin', 1) 372 | } 373 | { val.isKindOf(NodeProxy) or: { val.isKindOf(Symbol) } } { 374 | nil.asSpec 375 | } 376 | { 377 | "% using generic spec for '%'".format(this.class, key).warn; 378 | nil.asSpec 379 | }; 380 | 381 | // "Spec for paramname %: %".format(key, spec).postln; 382 | spec.addDependant(specChangedFunc); 383 | params.put(key, spec); 384 | }); 385 | }; 386 | 387 | if(parameterSection.notNil, { parameterSection.remove }); 388 | parameterSection = this.makeParameterViews(); 389 | sectionSize = parameterSection.sizeHint; 390 | parameterSection = ScrollView.new().canvas_(parameterSection); 391 | window.layout.add(parameterSection, 1); 392 | 393 | if(window.view.parent.isNil, { //resize only when not embedded 394 | window.view.bounds = window.view.bounds.resizeTo( 395 | window.view.bounds.width, 396 | (sectionSize.height + headerHeight + 30) //30 compensate default spacing 397 | .min(Window.availableBounds.height) 398 | ); 399 | }); 400 | } 401 | 402 | makeParameterViews { 403 | var view, vollabel, volLayout; 404 | 405 | view = View.new().layout_(VLayout.new()); 406 | 407 | if(nodeProxy.monitor.notNil and: { nodeProxy.rate == \audio }, { 408 | volslider = Slider.new() 409 | .orientation_(\horizontal) 410 | .value_(nodeProxy.vol) 411 | .action_({ | obj | 412 | nodeProxy.vol_(obj.value); 413 | volvalueBox.value_(obj.value); 414 | }); 415 | 416 | vollabel = StaticText.new 417 | .string_("vol"); 418 | 419 | volvalueBox = NumberBox.new() 420 | .decimals_(4) 421 | .action_({ | obj | 422 | obj.value = obj.value.clip(0.0, 1.0); 423 | volslider.value_(obj.value); 424 | nodeProxy.vol_(obj.value); 425 | }) 426 | .value_(nodeProxy.vol); 427 | 428 | volLayout = HLayout.new( 429 | [vollabel, s: 1], 430 | [volvalueBox, s: 1], 431 | [volslider, s: 4], 432 | ); 433 | view.layout.add(volLayout); 434 | }); 435 | 436 | paramViews.clear; 437 | params.sortedKeysValuesDo{ | key, spec | 438 | var layout, paramVal; 439 | var slider, valueBox, textField, staticText; 440 | var sliders, valueBoxes; 441 | 442 | paramVal = nodeProxy.get(key); 443 | 444 | layout = HLayout.new( 445 | if(collapseArrays.not and: { paramVal.isArray and: { paramVal.every(_.isNumber) } }, { 446 | [VLayout(*paramVal.collect { | v, n | 447 | StaticText.new().string_(key++"["++n++"]") 448 | }), s: 1] 449 | 450 | }, { 451 | [StaticText.new().string_(key), s: 1] 452 | }); 453 | ); 454 | 455 | case 456 | 457 | { paramVal.isNumber } { 458 | 459 | slider = Slider.new() 460 | .orientation_(\horizontal) 461 | .value_(spec.unmap(paramVal)) 462 | .action_({ | obj | 463 | var val = spec.map(obj.value); 464 | valueBox.value = val; 465 | nodeProxy.set(key, val); 466 | }); 467 | 468 | valueBox = NumberBox.new() 469 | .action_({ | obj | 470 | var val = spec.constrain(obj.value); 471 | slider.value_(spec.unmap(val)); 472 | nodeProxy.set(key, val); 473 | }) 474 | .decimals_(4) 475 | .value_(spec.constrain(paramVal)); 476 | 477 | // This is used to be able to fetch the sliders later when they need to be updated 478 | paramViews.put(key, (type: \number, slider: slider, numBox: valueBox)); 479 | 480 | layout.add(valueBox, 1); 481 | layout.add(slider, 4); 482 | } 483 | 484 | { collapseArrays.not and: { paramVal.isArray and: { paramVal.every(_.isNumber) } } } { 485 | 486 | sliders = paramVal.collect { |val, n| 487 | Slider.new() 488 | .orientation_(\horizontal) 489 | .value_(spec.wrapAt(n).unmap(val)) 490 | .action_({ | obj | 491 | var val = spec.wrapAt(n).map(obj.value); 492 | valueBoxes[n].value = val; 493 | nodeProxy.seti(key, n, val); 494 | }); 495 | }; 496 | 497 | valueBoxes = paramVal.collect { |pVal, n| 498 | NumberBox.new() 499 | .action_({ | obj | 500 | var val = spec.wrapAt(n).constrain(obj.value); 501 | sliders[n].value_(spec.wrapAt(n).unmap(val)); 502 | nodeProxy.seti(key, n, val); 503 | }) 504 | .decimals_(4) 505 | .value_(spec.wrapAt(n).constrain(pVal)); 506 | }; 507 | 508 | paramViews.put(key, (type: \array, sliders: sliders, numBoxes: valueBoxes)); 509 | layout.add(VLayout(*valueBoxes.collect{|v| [nil, v, nil]}.flat), 1); 510 | layout.add(VLayout(*sliders), 4); 511 | } 512 | 513 | { paramVal.isArray } { 514 | 515 | textField = TextField.new() 516 | .action_({ | obj | 517 | var val = try{ obj.value.interpret }; // this time as a feature! 518 | if(val.notNil, { 519 | val = val.asArray.collect{ | v, i | spec.wrapAt(i).constrain(v) }; 520 | obj.value = val; 521 | nodeProxy.set(key, val); 522 | }); 523 | }) 524 | .value_(paramVal); 525 | 526 | paramViews.put(key, (type: \array, textField: textField)); 527 | 528 | layout.add(textField, 5); 529 | } 530 | 531 | { paramVal.isKindOf(Bus) } { 532 | 533 | valueBox = NumberBox.new() 534 | .action_({ | obj | 535 | var bus; 536 | var val = spec.constrain(obj.value).asInteger; 537 | obj.value = val; 538 | bus = Bus.new(paramVal.rate, val, paramVal.numChannels); 539 | nodeProxy.set(key, bus); 540 | }) 541 | .value_(paramVal.index); 542 | 543 | staticText = StaticText.new() 544 | .string_(paramVal); 545 | 546 | paramViews.put(key, (type: \bus, numBox: valueBox, text: staticText)); 547 | 548 | layout.add(valueBox, 1); 549 | layout.add(staticText, 4); 550 | } 551 | 552 | { paramVal.isKindOf(Buffer) } { 553 | 554 | valueBox = NumberBox.new() 555 | .action_({ | obj | 556 | var buf; 557 | var val = spec.constrain(obj.value).asInteger; 558 | obj.value = val; 559 | buf = Buffer.cachedBufferAt(paramVal.server, val); 560 | if(buf.notNil, { 561 | nodeProxy.set(key, buf); 562 | }); 563 | }) 564 | .value_(paramVal.bufnum); 565 | 566 | staticText = StaticText.new() 567 | .string_(paramVal); 568 | 569 | paramViews.put(key, (type: \buffer, numBox: valueBox, text: staticText)); 570 | 571 | layout.add(valueBox, 1); 572 | layout.add(staticText, 4); 573 | } 574 | 575 | { paramVal.isKindOf(NodeProxy) } { 576 | 577 | if(paramVal.isKindOf(Ndef), { 578 | paramVal = "% (%, %)".format(paramVal, paramVal.rate, paramVal.numChannels) 579 | }); 580 | 581 | staticText = StaticText.new() 582 | .string_(paramVal); 583 | 584 | paramViews.put(key, (type: \proxy, text: staticText)); 585 | 586 | layout.add(staticText, 5); 587 | } 588 | 589 | { paramVal.isKindOf(Symbol) } { 590 | 591 | staticText = StaticText.new() 592 | .string_(paramVal); 593 | 594 | paramViews.put(key, (type: \map, text: staticText)); 595 | 596 | layout.add(staticText, 5); 597 | } 598 | 599 | { 600 | "% parameter '%' ignored".format(this.class, key).warn; 601 | }; 602 | 603 | view.layout.add(layout) 604 | }; 605 | 606 | view.children.do{ | c | c.font = font }; 607 | 608 | ^view 609 | } 610 | 611 | initFonts { 612 | var fontSize, headerFontSize; 613 | 614 | fontSize = 14; 615 | headerFontSize = fontSize * 2; 616 | 617 | headerFont = Font.sansSerif(headerFontSize, bold: true, italic: false); 618 | font = Font.monospace(fontSize, bold: false, italic: false); 619 | } 620 | 621 | randomize { | randmin = 0.0, randmax = 1.0 | 622 | this.filteredParamsDo{ | val, spec | 623 | spec.map(rrand(randmin, randmax)) 624 | } 625 | } 626 | 627 | vary { | deviation = 0.1 | 628 | this.filteredParamsDo{ | val, spec | 629 | spec.map((spec.unmap(val) + 0.0.gauss(deviation)).clip(0, 1)) 630 | } 631 | } 632 | 633 | excludeParams { ^prExcludeParams } 634 | 635 | excludeParams_ {| value | 636 | prExcludeParams = value; 637 | { this.makeParameterSection() }.defer; 638 | } 639 | 640 | defaults { 641 | this.filteredParamsDo{ | val, spec | 642 | spec.default 643 | } 644 | } 645 | 646 | ndef { ^nodeProxy } 647 | 648 | close { 649 | ^window.close() 650 | } 651 | 652 | filteredParamsDo { | func | 653 | this.filteredParams.keysValuesDo{ | key, spec | 654 | var val; 655 | 656 | val = nodeProxy.get(key); 657 | if(val.isArray, { 658 | val = val.collect{ | v, n | func.value(v, spec.wrapAt(n)) } 659 | }, { 660 | val = func.value(val, spec) 661 | }); 662 | 663 | nodeProxy.set(key, val) 664 | } 665 | } 666 | 667 | filteredParams { 668 | var accepted = IdentityDictionary.new; 669 | var ignored; 670 | 671 | ignored = defaultIgnoreParams ++ ignoreParams ++ defaultExcludeParams ++ prExcludeParams; 672 | 673 | nodeProxy.controlKeysValues.pairsDo({ | key, val | 674 | var spec; 675 | 676 | if(this.paramPresentInArray(key, ignored).not, { 677 | spec = (nodeProxy.specs.at(key) ?? { Spec.specs.at(key) }).asSpec; 678 | if(val.isNumber, { 679 | accepted.put(key, spec) 680 | }, { 681 | if(val.isArray, { 682 | accepted.put(key, spec.dup(val.size)) 683 | }) 684 | // Buffer and Bus values are ignored 685 | }) 686 | }) 687 | }); 688 | 689 | ^accepted 690 | } 691 | 692 | paramPresentInArray { | key, array | 693 | ^array.any{ | param | 694 | if(param.isString and: { param.indexOf($*).notNil }, { 695 | param.replace("*", ".*").addFirst($^).add($$).matchRegexp(key.asString) 696 | }, { 697 | param.asSymbol == key 698 | }) 699 | } 700 | } 701 | 702 | asCode { | includeMonitor = false, envir | 703 | var nameStr, accessStr = "a", isAnon; 704 | var str, position, map, ignored; 705 | 706 | envir = envir ? currentEnvironment; 707 | 708 | nameStr = envir.use { nodeProxy.asCompileString }; 709 | isAnon = nameStr.beginsWith("a = "); 710 | if(isAnon.not, { accessStr = nameStr }); 711 | 712 | str = nodeProxy.asCode(false, includeMonitor, envir); 713 | 714 | position = str.findBackwards(");", true); 715 | map = ProxyNodeMap(); 716 | ignored = defaultExcludeParams ++ prExcludeParams; 717 | 718 | nodeProxy.controlKeysValues.pairsDo({ | key, val | 719 | if(ignored.includes(key).not, { 720 | map.set(key, val) 721 | }); 722 | }); 723 | prExcludeParams.do{|x| map.removeAt(x)}; 724 | 725 | ^str.insert(position, map.asCode(accessStr, true)) 726 | } 727 | 728 | document { | includeMonitor = false | 729 | var nameStr = nodeProxy.class.asString ++"_" ++ nodeProxy.key; 730 | ^this.asCode(includeMonitor).newTextWindow("document-" ++ nameStr) 731 | } 732 | } 733 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . --------------------------------------------------------------------------------