OSCMapper | SuperCollider 3.13.0 Help

Description

OSCMapper is a Quark which intents to simplify the process of controlling SuperCollider with external OSC controllers such as TouchOSC.

Learn OSC controls

With OSCMapper it is possible to automatically create an OSCMapper layout according to the data it received which is often refered to as learning of controllers. Simply turn OSCMapper into learning modeOSCMapper.learn;

move the controllers (which should send its messages to the sclang standard port 57120, see NetAddr: *langPort) and once finished stop the learning process which will output a new controllerOSCMapper.finishLearn(\controller);

The detected mapping will be shown at the post video. There are

OSCMapperFader for faders with floating point range
OSCMapperPush for binary buttons
OSCMapperXY for 2 dimensional faders
OSCMapperAccXYZ for sensory data
OSCMapperArray for array data (not supported via learning)
OSCMapperKeyValue for array data in format [key1, value1, key2, value2, ...] (not supported via learning)

which all use OSCMapperElement as foundation.

How to use the OSC values

Assuming you have a OSC controller which is sending on address /1/fader and you have set up OSCMapper for this address you can access the value

as a Ndef// the osc mapper we created earlier // can be accessed in Ndef style o = OSCMapper(\controller); Ndef(\mySine, {SinOsc.ar!2 * o['/1/fader1'].asNdef}).play; Ndef(\mySine).clear(2);
as a Bus// use the default synth s = Synth(\default); s.map(\amp, o['/1/fader1'].asBus); s.free;
as a Pdefn( p = Pbind( \instrument, \default, \dur, 0.5, \degree, Pxrand((0..10), inf), \amp, o['/1/fader1'].asPdefn, ).play; ) p.stop;
as a raw valueo['/1/fader1'].value;
via a callback on changeo['/1/fader1'].callback = {|v| "value is now %".format(v).postln}; // and free the callback o['/1/fader1'].callback = {};

Creating a layout manually

In case you do not want to learn OscMapper everytime you boot up SuperCollider you can also define the layout manually like( o = OSCMapper(name: \controller, layout: ( '/1/fader1': OSCMapperFader( altName: \fader1, defaultValue: 0.5, transformer: linlin(_, 0.0, 1.0, 0.5, 10.0), callback: {|v| ["received a value", v].postln;}, lag: 0.5, ), '/1/xy1': OSCMapperXY( altName: \touchPanel ), )); )

By providing an altName you can access the value also via this name on the mapper, e.g.o[\fader1].value;

See How to use the OSC values above for further infos.

Using a preset

The presets from TouchOSC are already provided and can be simply loaded viao = OSCMapper.mix2(name: \controller); o['/1/fader1'].value;

See How to use the OSC values above for further infos.

Using def style access

Each OSCMapper needs to have a unique name. This is for internal reasons (as each Ndef also needs a unique address) but also to make the access to the OSCMapper easier.o = OSCMapper(\my, layout: ('/1/fader1': OSCMapperFader())); // access it via variable o['/1/fader1'].value; // access it via def style OSCMapper(\my)['/1/fader1'].value;

Updating a layout

Lets say you want to change or modify an existing layout.o = OSCMapper(\my, layout: ('/1/fader1': OSCMapperFader()));

Then we can add another address on the fly by modifying the existing layouto.layout['/1/fader2'] = OSCMapperFader();

And also modify the existing layout by adding a transformer or a callback.o['/1/fader2'].callback = {|v| "Got called: %".format(v).postln}; o['/1/fader2'].transformer = linlin(_, 0.0, 1.0, 20.0, 400.0);

and also remove an existing elemento.layout['/1/fader2'] = nil;

Class Methods

.new

Will create a new OSCMapper. Will also add a Main: -addOSCRecvFunc which allows us to search trough all OSC messages.

Arguments:

name	Should be unique as we also allow to access the instances in an Ndef manner.
layout	An Event where key is the OSC address and the value is a OSCMapperElement which accepts the value.
port	Defaults to nil which will listen to all ports entered in Main: -openPorts (which can be seen via `thisProcess.openPorts` which defaults to NetAddr: *langPort which defaults to 57120). If a port is set we will tell sclang to listen on this port as well and we restrict the created OSCMapper to the stated port number. This allows you to use multiple devices with the same layout by using different ports.

.learn

Puts OSCMapper in capture mode. Should be followed by OSCMapper: *finishLearn

.finishLearn

Will create a OSCMapper according to the messages that were received since OSCMapper: *learn was called.

Arguments:

name	See OSCMapper: *new.

.mix2

Constructor with layout for TouchOSC preset Mix 2. For other args see OSCMapper: *new.

Arguments:

name
port

.mix2iPad

Constructor with layout for TouchOSC preset Mix 2 iPad. For other args see OSCMapper: *new.

Arguments:

name
port

.all

Will return an Event with all registered OSCMappers where the key is the name.

.clearAll

Removes all instances of OSCMapper.

.echo

Allows to output the currently received OSC messages, like OSCFunc: *trace. This is useful to identify the touched controls.

Arguments:

echoBool

if true it will print the received values to the Post window. When set to false it will stop posting.

Instance Methods

.at

Allows to access the addresses via e.g. o['/1/fader1']

Arguments:

address

The address or altname given.

.layout

Allows to access and update the given layout. See Updating a layout above on how to use it.

.clear

Removes any server resources and also any callbacks in the language.

Examples

Multitoggles as step sequencer

The layout OSCMapper: *mix2iPad includes a 5x5 matrix which we can use as a 25 step sequencer. The OSC address for these is /1/multitoggleK/i/j where K is the K-th multitoggle, i the column and j the row (so maybe a bit unintuitive but thats how it is in the interface).( o = OSCMapper.mix2iPad; // create an array of [o['.../1/1'].asPdefn, o['.../1/2'].asPdefn, ...] t = (1..5).collect({|i| (1..5).collect({|j| o["/1/multitoggle1/%/%".format(j, i).asSymbol].asPdefn }) }).flatten; Pdef(\myPattern, Pbind( \instrument, \default, \dur, 0.125, \degree, Pseq((0..5), inf), // use the button values of 1/0 as amp values \amp, Pseq(t, inf), )).play; ) Pdef(\myPattern).stop; // modify the array creation to e.g. 1..4 to get a 16 step sequencer

Activate a ProxyChain// create a synthdef ( SynthDef(\percSaw, {|out| var sig = Saw.ar(\freq.kr(200.0)); var env = EnvGen.kr(Env.perc( attackTime: \attackTime.kr(0.01), releaseTime: \releaseTime.kr(0.1), ), doneAction: Done.freeSelf); sig = Pan2.ar(sig*env, pos: \pos.kr(0.0)) * \amp.kr(0.2); Out.ar(out, sig); }).add; // create a proxychain source ProxyChain.add3( srcName: \delay, source: \filter -> {|in| DelayC.ar( in: (in*\preAmp.kr(1.0)).tanh, maxdelaytime: 0.2, delaytime: 0.2 * [1.0, \delayOffset.kr(0.9)]; ).sum}, level: 1.0, ); ) // create the actual proxy chain ProxyChain(\p, [\delay], numChannels: 2).play.gui; // play a pattern through the proxy chain ( Pdef(\myPattern, Pbind( \instrument, \percSaw, \dur, 0.125, \degree, Pseq((0..5), inf), \amp, 0.5, \out, ProxyChain(\p).proxy.index, )).play; ) // create our OSC mapper o = OSCMapper.mix2; // create a callbacks on our push ( o['/1/toggle1'].onPress = {ProxyChain(\p).add(\delay, 0.5)}; o['/1/toggle1'].onRelease = {ProxyChain(\p).remove(\delay)}; ) // modify a ProxyChain parameter via osc parameter o['/1/fader1'].callback = {|v| ProxyChain(\p).set(\delayOffset, v)}; // clean up Pdef(\myPattern).clear;

Play/Stop patterns( Pdef(\myPattern, Pbind( \instrument, \default, \degree, Pxrand((0..5), inf), \dur, 0.25, )); ) ( o['/1/toggle1'].onPress = {Pdef(\myPattern).play}; o['/1/toggle1'].onRelease = {Pdef(\myPattern).stop}; )

helpfile source: HelpSource/Classes/OSCMapper.schelp
link::OSCMapper/Classes/OSCMapper::

OSCMapperExtension

Description

Class Methods

.new

Arguments:

.learn

.finishLearn

Arguments:

.mix2

Arguments:

.mix2iPad

Arguments:

.all

.clearAll

.echo

Arguments:

Instance Methods

.at

Arguments:

.layout

.clear

Examples

OSCMapper
Extension