SPList | SuperCollider 3.13.0 Help

Description

SPlist is a set of classes for non-realtime-soundfile-transformation.

For the most reliable and well tested analysis of a sound file you need to have the programm "splistanalyst" installed. In the moment I make the assumption that "splistanalyst" would be only installed on linux.

Now sound-file analysis files can also be created from within supercollider but the process is not well tested.

SPList is like a List operating on its own content, it is not creating a new copy.

Many methods work in the same way as methods of Collection and List work I do not document them here.

The SPL.sc file contains extensions to splist which provide specific use cases they are not documented here for now.

Class Methods

.new

creates a new empty SPList. Usually not used by hand.

Bund methods

These are the four bund methods that generate a single value from the values of a type in a SPList.

avr

average of all values in a SPList.

sum

sum of all values in a SPList.

small

smallest of all values in a SPList.

big

biggest of all values in a SPList.

Arguments:

type	type of analysed data: \amp,\rms,\freq,\length,\sec,\peaks,\delta

Returns:

a Float

subavr

subsum

subsmall

subbig

When the elements of a SPList are SPLists it might be desirable to calculate their values with a different function than the top layer. The bund function for the containing SPLists is given as argument.

Arguments:

type	type of analysed data: \amp,\rms,\freq,\length,\sec,\peaks,\delta
bund	If the SPList contains SPLists bund defines how they are calculated together. Choose either of the following Symbol: \avr, \sum, \small, \big

Returns:

a Float

Clumping methods

grainThreshNeg

Clumps all periods together starting from the point when a threshhold is crossed towards a lower value of a type until it happens again.

grainThreshPos

Clumps all periods together starting from the point when a threshhold is crossed towards a higher value of a type until it happens again.

grainThreshSplit

Clumps all periods together between crossings of a threshhold (in both directions).

Arguments:

threshhold	Threshhold value
type	type of analysed data either of the following Symbol: \amp,\rms,\freq,\length,\sec,\peaks,\delta
bund	If the SPList contains SPLists bund defines how they are calculated together. Choose either of the following Symbol: \avr, \sum, \small, \big

Returns:

(describe returnvalue here)

grainMax

Clumps all periods together between two maxima of a value of a type.

grainMin

Clumps all periods together between two minima of a value of a type.

Arguments:

type	type of analysed data: \amp,\rms,\freq,\length,\sec,\peaks,\delta
bund	If the SPList contains SPLists bund defines how they are calculated together. Choose either of the following Symbol: \avr, \sum, \small, \big

Split methods (alternative to Clumping methods)

Split methods split a SPList into two parts (and put these two parts as suplist into the SPList)

splitHalf

Split a list in the middle of the SPList.

splitAfter

Split after Nth element of a SPList.

splitBefore

Split before Nth element of a SPList.

Arguments:

at	Integer position.

splitNextMax

Split at next local maximum of a value of a type.

splitNextMin

Split at next local minmum of a value of a type.

Arguments:

area	This argument describes the number of list elements around the middle of a SPList that are taken into consideration.
type	type of analysed data: \amp,\rms,\freq,\length,\sec,\peaks,\delta
bund	If the SPList contains SPLists bund defines how they are calculated together. Choose either of the following Symbol: \avr, \sum, \small, \big

splitN

Recursive split method. splits SPList N times in two parts.

// RECURSE SPLIT FUNCTIONS // teile deep mal in 2 teile (also 2.pow(deep)) // mithilfe der angegebenen splitfunktion und ihrer argumente // wird die splitposition bestimmt (describe method here)

Arguments:

deep	How often sthe split function should be performed.
sfunc	Symbol of a split function
... args	arguments of a split funtion: \splitHalf \splitAfter \splitBefore \splitNextMin \splitNextMax

Transformations

loop

Repeats each element of the SPList n times.

internalloop

Repeats the whole content of a SPList.

internalloopcopy

Repeats the whole content of a SPList and create deep copies for each instance.

Arguments:

n	number of repetition in addition to the existing one.

env

Applies a SPEnv Envelope on a SPList.

Arguments:

envelope

Needs a SPEnv object.

interleave

interleaves two SPLists

Arguments:

anSPList	a SPList
cutend	Boolean true: the shorter SPList should define the length of the total new list false: the shorter file gets looped.

sortBy

The usual way to sort a SPList is by this method. A SPList is sorted acording to the values of a type.

Arguments:

type	type of analysed data: \amp,\rms,\freq,\length,\sec,\peaks,\delta
bund	If the SPList contains SPLists bund defines how they are calculated together. Choose either of the following Symbol: \avr, \sum, \small, \big

reverse

reverse the splist

Export and Playback

play

Play back a SPList. Writes a sound file and plays it back.

Arguments:

spf	Function that transforms the start pos of each element of a SPList on the top level.
spfd	Function that transforms the start pos of each element of a SPList on the lower levels.

write

Writes a sound file.

Arguments:

nrtServerOptions	a instance of NRTServerOptions.
spf	Function that transforms the start pos of each element of a SPList on the top level.
spfd	Function that transforms the start pos of each element of a SPList on the lower levels.

Helper methods

nodecount

Returns the number of Periods.

Returns:

a Integer

parent

returns the parent of a SPList.

Returns:

a SPList

flat

Make SPList flat again. Remove all clumping of SPLists.

length

Length in samples of a SPList

howDeep

returns how deep the SPList structure is.

performOnPeriod

Perform a method on the Periods within a SPList

Arguments:

method	method key
... args	argument of the method

Returns:

a Integer

appendSPList

Append a SPList to this SPList

Arguments:

anSPList

deepCopy

Creates a deepCopy of a SPList. This is necessary when different transformations on the same source material should be applied.

Returns:

a SPList

reset

Attempts to bring a SPList into its original shape. But it can not recreate deleted Periods.

flatSub

Some kind of wheiered flattening method

flattenSub

another strange flatten method

print

Print values of a specific type of the SPList. (should make use of bund method)

Arguments:

type	type of analysed data: \amp,\rms,\freq,\length,\sec,\peaks,\delta

doDeep

apply a do on all levels of a SPList structure.

Arguments:

function

The first argument is the current splist. The second argument is the value of deepness.

Examples

//start
s.boot

// the play method creates wav files in your /tmp/ folder maybe you have to delete them yourself when you restart your computer seldome

//load file
a=SPLSourceFile.newSPL(2,"test.wav");//choose your example file

//show file
// a.plot // not impmented anymore

//play file
a.play // plays file after being reconstructed + 1 second

//transform: transpose
a.do{|i|i.transpose(2)}.play

//reset
a.reset

//transform: transpose each period differently
a.do{|i|i.transpose(rrand(0.9,1.1))}.play

//reset only works sometimes not when used loop or delete!!

//transposeTo
a.do{|i|i.transposeToFreq(440)}.play
a.reset

//gain
a.do{|i|i.gain(exprand(1,0.1))}.play
a.reset

//addSine 4th overtone, volume of sine,volume of original sound
a.do{|i|i.addSine(4,0.5,0.5)}.play
a.reset

//merge
b=SPLSourceFile.newSPL(2,"test.wav");
b.reverse
a.do{|item,i|item.merge(b[i])}.play
a.reset

//env in the moment env is based on my
//SPEnv subclass of Env because i added
//a write method ... this now also aviable in Env
//so this will be changed
e=SPEnv.new([0,1,0], [1,1],'welch');
a.do{|i|i.env(e)}.play; //some kind of amplitude modulation
a.reset

//new effect

(
//!!! it will be loud!!!
SynthDef("distortion",{arg size;
    //env is important to mute some rests
    var env=EnvGen.ar(Env.new([1,1,0], [size/SampleRate.ir,0]), doneAction: 2);
    //input
    var sig=In.ar(100);
    //the effect
    sig=sig%2-1*0.1;
    //output_
    ReplaceOut.ar(100,sig);
}).writeDefFile;
)

a.do{|i|i.addEffect(\distortion)}.play;
a.reset

//sequence transformations
//sorting
a.sort{|a,b|a.peaks<b.peaks}.play;
a.sortBy(\amp).play;
a.sortBy({|i|1-i.amp}).play;

//interleaving
b=SPLSourceFile.newSPL(2,"sounds/a11wlk01.wav");
a.interleave(b);
a.play
a=SPLSourceFile.newSPL(2,"sounds/a11wlk01.wav");

//grouping:

//grain
a.grainMin(\amp);
a.grainMin(\amp,\avr);
a.sortBy(\amp);
a.play;
a.reset;

a.grainMax(\freq);
a.grainMax(\freq,\avr);
a.grainMax(\freq,\avr);
a.sortBy(\amp);
a.play;
a.reset;

//thresh
a.grainThreshPos(a.avr(\amp),\amp,\avr);
a.sortBy(\amp);
a.play;
a.reset;

a.grainThreshSplit(a.avr(\amp),\amp,\avr);
a.sortBy(\amp);
a.play;
a.reset;

//split
a.splitN(7,\splitNextMin,90,\amp,\avr);
a.sortBy(\amp);
a.play;
a.reset;

//loop
a.do({|item,i,s,b|item.loop(item.amp.linlin(s,b,0,10).round)},a.small(\amp),a.big(\amp)).play
a=SPLSourceFile.newSPL(2,"sounds/a11wlk01.wav");

//delete
e=a.avr(\amp);
a.do{|i|if(i.amp<e,{i.delete})}.play
a=SPLSourceFile.newSPL(2,"sounds/a11wlk01.wav");

//density

//stretch
a.play({|startpos,dur,i,item|startpos+(dur*10)})

//layer
a.play({|startpos,dur,i,item|startpos+(dur/2)})

a.grainMin(\amp,\avr).grainMin(\amp,\avr);
a.gain(0.4)
a.play({|startpos,dur,i,item|startpos+(dur/2)})
a.reset

//deep stretch ... something nobody needs
a.grainMin(\amp,\avr).grainMin(\amp,\avr).grainMin(\amp,\avr);
a.play({|startpos,dur,i,item|startpos+dur},{|startpos,dur,i,item,deep|startpos+(dur*(i/5+0.8))})
a.reset

//toplevel layer deep stretch
a.grainMin(\amp,\avr).grainMin(\amp,\avr).grainMin(\amp,\avr);
a.gain(0.3)
a.play({|startpos,dur,i,item|startpos+(dur/2)},{|startpos,dur,i,item,deep|    startpos+(dur*2)})
a.reset

Complex methods

No time right now to document.

grainEnv

(describe method here)

Arguments:

levels	(describe argument here)
times	(describe argument here)
curves	(describe argument here)
releaseNode	(describe argument here)
loopNode	(describe argument here)

Returns:

(describe returnvalue here)

pitchShift

(describe method here)

Arguments:

fx	(describe argument here)
... args	(describe argument here)

Returns:

(describe returnvalue here)

timeStretchRand

(describe method here)

Arguments:

newtime

(describe argument here)

Returns:

(describe returnvalue here)

timeStretch

(describe method here)

Arguments:

newtime

(describe argument here)

Returns:

(describe returnvalue here)

pitchShiftLoop

(describe method here)

Arguments:

fx	(describe argument here)
... args	(describe argument here)

Returns:

(describe returnvalue here)

transposeCurve

(describe method here)

Arguments:

p1	(describe argument here)
p2	(describe argument here)
p3	(describe argument here)

Returns:

(describe returnvalue here)

helpfile source: HelpSource/SPList.schelp
link::SPList/SPList::

SPListExtension

.new

Arguments:

Returns:

Arguments:

Returns:

Arguments:

Returns:

Arguments:

Arguments:

Arguments:

Arguments:

Arguments:

Arguments:

Arguments:

Arguments:

Arguments:

Arguments:

Returns:

Returns:

Arguments:

Returns:

Arguments:

Returns:

Arguments:

Arguments:

Arguments:

Returns:

Arguments:

Returns:

Arguments:

Returns:

Arguments:

Returns:

Arguments:

Returns:

Arguments:

Returns:

SPList
Extension