MainFX | SuperCollider 3.13.0 Help

Subclasses: MasterFX

Description

A MainFX can apply effects to the main output channels of a server. One can only make a single MainFX for each server. Each mainFX contains a ProxyChain which handles the named effects slots and their state.

Note that MainFX can be used with ProxyChainPreset, see ProxyChainPreset, in the bottom examples.

NOTE: that MainFX used to be called MasterFX - please rename all uses of it to MainFX.

First examples:( s.boot; // define which FX are going to be used. // As MainFX is based on ProxyChain, these FX are the same as in ProxyChain. ProxyChain.add3( \leakDC, \filter -> { |in, leak=0.99| LeakDC.ar(in, leak) }, 1, (\leak: [0.5, 0.999, \exp]) ); ProxyChain.add3( \rollClip, \filter -> { |in, clip=0.99, pole=0.2| OnePole.ar(in.clip2(clip), pole ** 0.7); }, 1, ( \clip: [0.0, 1, \amp], \pole: [0, 0.95, \lin] ) ); ProxyChain.add3( \krush, \filter -> { |in, bits=16, downsamp=2| var krushStep = 0.5 ** (bits + 1); var down = Latch.ar(in, Impulse.ar(SampleRate.ir / downsamp.max(2))); // below 1/2 downsamp, do xfade: blend(in, down, (downsamp - 1).clip(0, 1)) .round(krushStep); }, 1, ( \bits: [16, 1], \downsamp: [1, 100, \exp] ) ); ProxyChain.add3( \slap, \filterIn -> { |in, dtl = 0.25, dtr = 0.375, decay = 3| CombL.ar(in, 1.0, [dtl, dtr], decay) }, 0.2, (dtl: [0, 1], dtr: [0, 1], decay: [1, 200, \exp]) ); ProxyChain.add3( \comb, \filterIn -> { |in, decay = 3| CombL.ar(in * 0.3, 0.02, [0.03, 0.042], decay) }, 0.2, (decay: [0.2, 200, \exp]) ); ProxyChain.add3( \ampFin, \filter -> { |in, drive=1, ampLimit=0.8 | Limiter.ar(in * drive, ampLimit); }, 1, ( \drive: [1, 10, \exp], \ampLimit: \amp ) ); ); ( // An 8-channel MainFX on server s. // The order in slotNames determines order of execution of the efx. m = MainFX.new(server: s, numChannels: 8, slotNames: [\leakDC, \krush, \rollClip, \ampFin], busIndex: 0 ); g = m.gui; // a GUI s.scope(8); ) // a test signal x = { PinkNoise.ar(0.5) + SinOsc.ar([220, 330]) * LFNoise2.kr([5, 8, 13, 21]).max(0); }.play; // all MainFX live here: MainFX.all; // kick in predefined effects (at full wet level) m.add(\leakDC, 1); m.set(\leak, 0.8); // filter lows m.add(\krush, 1); // bitcrush, downsample m.set(\bits, 5, \downsamp, 6); m.add(\ampFin, 1); // limit output m.set(\drive, 10, 0.3); // kick out predefined effects (at full wet level) m.remove(\leakDC); m.remove(\rollClip); m.remove(\krush); m.remove(\ampFin); // remove currently unused settings m.proxy.cleanNodeMap; // change slotNames - only while slots are off : m.slotNames; // this is -> Order[\leakDC, \krush, \rollClip, \ampFin] // drop rollClip from the list: m.slotNames = [\leakDC, \krush, \ampFin]; ( // make a more specific GUI - see ProxyChainGui for details g = m.gui(\Mestre, 20, [ [\leakDC, \slotCtl, 1], [\rollClip, \slotCtl, 1], [\krush, \slotCtl, 1], [\ampFin, \slotCtl, 1], [\RESET, \extra, { m.pxChain.add(\leakDC, 1).add(\ampFin, 1) }], ]) ) // remove a MainFX by server name MainFX.clear(\localhost); // clear one specific mainFX // or simply by m.clear // or clear all MainFX MainFX.clear; MainFX.all;

Class Methods

MainFX.all

dictionary for all mainFX, one per server.

MainFX.default

the MainFX instance for the default server.

MainFX.maxNumChans

the maximum number of channels supported. (currently unused)

MainFX.clear(name)

clear the mainFX at name

Arguments:

name

MainFX.new(server, numChannels, slotNames, busIndex)

Arguments:

server	the server on which the MainFX chain will run; default is server.numOutputBusChannels
numChannels	the number of channels it will work on
slotNames	the names of the filters/functions to be used, in order of execution;
busIndex	the bus index where it will process audio.

Inherited class methods

Instance Methods

.key

the key at which the mainFX is stored; usually this is the server name.

.proxyChain

the ProxyChain that has the order of the effects that can be used

.proxy

the NodeProxy inside the the proxyChain.

Methods that get forwarded to proxyChain/proxy:

.add(key, wet, func)

kick in effect

Arguments:

key	name of effect
wet	wet-level of effect
func	an optional func that can locally replace the global func with that name.

.remove(key)

kick out effect

Arguments:

key	name of effect

.set( ... args)

set named parameters of the active slots

.slotsInUse

get the currently used slots of the proxyChain

.slotNames

.slotNames = argSlotNames

get and set the slotNames of the proxyChain

.server

the server on which this MainFX operates

.numChannels

the number of output channels of the MainFX

.busIndex

the index of the bus on which the MainFX operates

.group

the group in which this mainFX proxy runs. this is after the default group.

.checkingBadValues

flag whether the mainFX is checking the final output for bad values. see also CheckBadValues

.checkBad(flag)

set flag whether to check final output, and if needed start the synth

.badSynth

the synth that does the bad value checking.

.wakeUp

Wake up the MainFX proxy. This happens automatically after CmdPeriod.

.clear

clear this MainFX; usually so one can remake it.

.pxChain

alias for the proxyChain (the proxyChain inst var was called pxChain earlier).

.show

.hide

show or hide the MainFX proxy in Ndef.all for that server. the proxy is hidden by default.

.gui(name, numItems, buttonList, parent, bounds, makeSkip: true)

make a MainFXGui for the MainFX.

Arguments:

name	the name the gui will show
numItems	the number of buttons / sliders for parameters the gui will have
buttonList	an optional list of buttons. by default, this is the list of slotNames.
parent	the parent view or window on which to place the gui
bounds	the bounds of the gui
makeSkip	a flag whether to make and start a skipjack for the gui update mechanism.

Inherited instance methods

Undocumented instance methods

.doOnServerTree

.init2(inServer, inNumChannels, inSlotNames, inBusIndex)

Examples

// An example for setting up shared controls between slots:
// volume levels of both a slap delay and a comb reverb are scaled by \globalwet.
(
// first, add global spec for \globalwet:
Spec.add(\globalwet, [0, 4, \amp]);

// then make a dummy first slot function that has all global controls,
ProxyChain.add3(
    \globalz, { |globalwet = 1|
        // but does not add any sound to the proxychain:
        Silent.ar
    }
);

// add slap delay that uses globalwet scaler
ProxyChain.add3(
    \slap, \filterIn -> { |in, globalwet = 1, dtl = 0.25, dtr = 0.3333|
        DelayN.ar(in.reverse * globalwet, 1.0, [dtl, dtr])
    },
    0.38,
    (dtl: [0, 1], dtr: [0, 1], decay: [1, 200, \exp])
);

// add simple comb reverb that uses globalwet scaler
ProxyChain.add3(
    \comb, \filterIn -> { |in, globalwet = 1, decay = 3|
        CombL.ar(in * (0.3 * globalwet), 0.02, LFDNoise3.kr(0.1!2).range(0.01, 0.03), decay)
    },
    0.38,
    (decay: [0.2, 200, \exp])
);

// make a MainFX that uses globals
MainFX.clear('localhost');
m = MainFX.new(server: s,
    numChannels: 2,
    slotNames: [\globalz, \something, \slap, \other, \comb, \final],
    busIndex: 0
);
///// add globalz by default!
m.add(\globalz);

// make a gui to show state:
g = m.gui; // a GUI
)

// NOW, test globalwet control:
// run a simple test sound
x = { Splay.ar(Ringz.ar(Impulse.ar(0.3 * [2, 3, 5]), [2, 3, 5] * 300, 0.5/[2, 3, 5])) }.play;

m.add(\slap, 0.38); // turn on slapback
m.set(\globalwet, 0.5); // drier
m.set(\globalwet, 2); // wetter
m.set(\globalwet, 1); // normal

m.add(\comb, 0.38); // turn on comb
m.set(\globalwet, 0.25); // much drier, slap and comb!
m.set(\globalwet, 2); // wetter
m.set(\globalwet, 1); // normal again

helpfile source: /home/bgola/.local/share/SuperCollider/downloaded-quarks/JITLibExtensions/HelpSource/Classes/MainFX.schelp
link::Classes/MainFX::

MainFX : Object Extension

MainFX.all

MainFX.default

MainFX.maxNumChans

MainFX.clear(name)

Arguments:

MainFX.new(server, numChannels, slotNames, busIndex)

Arguments:

.key

.proxyChain

.proxy

.add(key, wet, func)

Arguments:

.remove(key)

Arguments:

.set( ... args)

.slotsInUse

.slotNames

.slotNames = argSlotNames

.server

.numChannels

.busIndex

.group

.checkingBadValues

.checkBad(flag)

.badSynth

.wakeUp

.clear

.pxChain

.show

.hide

.gui(name, numItems, buttonList, parent, bounds, makeSkip: true)

Arguments:

.doOnServerTree

.init2(inServer, inNumChannels, inSlotNames, inBusIndex)

MainFX : Object
Extension