cleaned declarations of all real time classes, plus basic test files with null summing (except HPSS which I cannot figure out yet)

release-packaging/Classes/FluidTransients.sc

@@ -1,6 +1,6 @@
 FluidTransients : MultiOutUGen {
-	*ar { arg in = 0, order = 20, blocksize = 256, padding = 128, skew = 0.0, threshFwd = 3.0, threshBack = 1.1, winSize=14, debounce=25;
+	*ar { arg in = 0, order = 20, blockSize = 256, padding = 128, skew = 0.0, threshFwd = 3.0, threshBack = 1.1, winSize=14, debounce=25;
-		^this.multiNew('audio', in.asAudioRateInput(this), order, blocksize, padding, skew,threshFwd ,threshBack, winSize,debounce)
+		^this.multiNew('audio', in.asAudioRateInput(this), order, blockSize, padding, skew,threshFwd ,threshBack, winSize,debounce)
 	}
 	init { arg ... theInputs;
 		inputs = theInputs;

release-packaging/HelpSource/Classes/FluidHPSS.schelp

@@ -1,3 +1,63 @@
-s.reboot
+TITLE:: FluidHPSS
-b = Buffer.cueSoundFile(s,"/Users/owen/Desktop/denoise_stn/sources/01-mix.wav",0,1)
+summary:: (put short description here)
-x = {FluidHPSS.ar(DiskIn.ar(1,b.bufnum,loop:1))}.play
+categories:: Libraries>FluidDecomposition
+related:: Guides/FluCoMa, Guides/FluidDecomposition
+
+DESCRIPTION::
+It is part of the Fluid Decomposition Toolkit of the FluCoMa project. footnote::
+This  was made possible thanks to the FluCoMa project (http://www.flucoma.org/) funded by the European Research Council (https://erc.europa.eu/) under the European Union’s Horizon 2020 research and innovation programme (grant agreement No 725899).::
+
+
+CLASSMETHODS::
+
+METHOD:: ar
+(describe method here)
+
+ARGUMENT:: in
+(describe argument here)
+
+ARGUMENT:: percussiveFilterSize
+(describe argument here)
+
+ARGUMENT:: harmonicFilterSize
+(describe argument here)
+
+ARGUMENT:: percussiveThreshold
+(describe argument here)
+
+ARGUMENT:: harmonicThreshold
+(describe argument here)
+
+ARGUMENT:: windowSize
+(describe argument here)
+
+ARGUMENT:: hopSize
+(describe argument here)
+
+ARGUMENT:: fftSize
+(describe argument here)
+
+returns:: (describe returnvalue here)
+
+
+INSTANCEMETHODS::
+
+METHOD:: checkInputs
+(describe method here)
+
+returns:: (describe returnvalue here)
+
+METHOD:: init
+(describe method here)
+
+ARGUMENT::  ... theInputs
+(describe argument here)
+
+returns:: (describe returnvalue here)
+
+
+EXAMPLES::
+
+code::
+(some example code)
+::

release-packaging/HelpSource/Classes/FluidSines.schelp

@@ -1,4 +1,66 @@
-s.reboot;
+TITLE:: FluidSines
-b = Buffer.cueSoundFile(s,"/Users/owen/Box Sync/FluCoMa/Test files/SMS test files/Test Files/PAs 24 bit files/maxou-FR-a-k.wav.wav",0,1);
+summary:: (put short description here)
-b.query
+categories:: Libraries>FluidDecomposition
-x = {FluidSines.ar(DiskIn.ar(1,b.bufnum))}.play;
+related:: Guides/FluCoMa, Guides/FluidDecomposition
+
+DESCRIPTION::
+It is part of the Fluid Decomposition Toolkit of the FluCoMa project. footnote::
+This  was made possible thanks to the FluCoMa project (http://www.flucoma.org/) funded by the European Research Council (https://erc.europa.eu/) under the European Union’s Horizon 2020 research and innovation programme (grant agreement No 725899).::
+
+
+CLASSMETHODS::
+
+METHOD:: ar
+(describe method here)
+
+ARGUMENT:: in
+(describe argument here)
+
+ARGUMENT:: bandwidth
+(describe argument here)
+
+ARGUMENT:: threshold
+(describe argument here)
+
+ARGUMENT:: minTrackLen
+(describe argument here)
+
+ARGUMENT:: magnitudeWeight
+(describe argument here)
+
+ARGUMENT:: frequencyWeight
+(describe argument here)
+
+ARGUMENT:: windowSize
+(describe argument here)
+
+ARGUMENT:: hopSize
+(describe argument here)
+
+ARGUMENT:: fftSize
+(describe argument here)
+
+returns:: (describe returnvalue here)
+
+
+INSTANCEMETHODS::
+
+METHOD:: checkInputs
+(describe method here)
+
+returns:: (describe returnvalue here)
+
+METHOD:: init
+(describe method here)
+
+ARGUMENT::  ... theInputs
+(describe argument here)
+
+returns:: (describe returnvalue here)
+
+
+EXAMPLES::
+
+code::
+(some example code)
+::

release-packaging/HelpSource/Classes/FluidTransients.schelp

@@ -1,6 +1,66 @@
-s.reboot;
+TITLE:: FluidTransients
-b = Buffer.cueSoundFile(s,"/Users/owen/Desktop/denoise_stn/sources/01-mix.wav",0,1);
+summary:: (put short description here)
+categories:: Libraries>FluidDecomposition
+related:: Guides/FluCoMa, Guides/FluidDecomposition
 
+DESCRIPTION::
+It is part of the Fluid Decomposition Toolkit of the FluCoMa project. footnote::
+This  was made possible thanks to the FluCoMa project (http://www.flucoma.org/) funded by the European Research Council (https://erc.europa.eu/) under the European Union’s Horizon 2020 research and innovation programme (grant agreement No 725899).::
 
-b.query
+
-x = {FluidTransients.ar(DiskIn.ar(1,b.bufnum))}.play;
+CLASSMETHODS::
+
+METHOD:: ar
+(describe method here)
+
+ARGUMENT:: in
+(describe argument here)
+
+ARGUMENT:: order
+(describe argument here)
+
+ARGUMENT:: blockSize
+(describe argument here)
+
+ARGUMENT:: padding
+(describe argument here)
+
+ARGUMENT:: skew
+(describe argument here)
+
+ARGUMENT:: threshFwd
+(describe argument here)
+
+ARGUMENT:: threshBack
+(describe argument here)
+
+ARGUMENT:: winSize
+(describe argument here)
+
+ARGUMENT:: debounce
+(describe argument here)
+
+returns:: (describe returnvalue here)
+
+
+INSTANCEMETHODS::
+
+METHOD:: checkInputs
+(describe method here)
+
+returns:: (describe returnvalue here)
+
+METHOD:: init
+(describe method here)
+
+ARGUMENT::  ... theInputs
+(describe argument here)
+
+returns:: (describe returnvalue here)
+
+
+EXAMPLES::
+
+code::
+(some example code)
+::

src/FluidBufCompose/tests.scd

@@ -43,7 +43,6 @@ Routine{
 )
 
 //constructing a one second buffer: the first second of each buffer, the mono synth on the right, the piano on the left
-process monosynth 0 44100 0 1 1 0 1 stereopiano 0 44100 0 1 1 dst
 (
 Routine{
 	t = Main.elapsedTime;

src/FluidBufNMF/tests.scd

@@ -102,10 +102,11 @@ Routine{
 	~hop_size = 256;
 	s.sync;
 	FluidBufCompose.process(s,b.bufnum,srcBufNumB:c.bufnum, srcGainB:0.6, dstStartChanB:1, dstBufNum:d.bufnum);
+	s.sync;
+	d.query;
 }.play;
 )
 
-d.query
 d.play
 
 (
@@ -118,6 +119,8 @@ Routine{
 )
 
 e.query
+x.query
+y.query
 
 //test a single rank
 {PlayBuf.ar(10,e.bufnum,doneAction:2)[9].dup}.play

src/FluidHPSS/test.scd

@@ -0,0 +1,33 @@
+s.reboot;
+
+b = Buffer.read(s,"/Users/pa/Documents/documents@hudd/research/projects/fluid corpus navigation/research/archives-2017-18/denoise_stn/sources/01-mix.wav");
+b.play
+
+// basic param
+{FluidHPSS.ar(PlayBuf.ar(1,b.bufnum,loop:1))}.play
+
+// sexier params
+{FluidHPSS.ar(PlayBuf.ar(1,b.bufnum,loop:1),17,31,0,0,1024,512,2048)}.play
+
+
+
+
+
+// null test (the process add a latency of ((harmonicFilterSize +1) *  windowSize / 2) samples NOT WORKING ARGGGG
+{var sig = PlayBuf.ar(1,b.bufnum,loop:1); [FluidHPSS.ar(sig,17,21,0,0,1024,512,2048).sum , DelayN.ar(sig, 1, ((31 + 1) *  1024 / 2 / s.sampleRate))]}.play
+
+{var sig = PlayBuf.ar(1,b.bufnum,loop:1); [FluidHPSS.ar(sig,17,31,0,0,1024,512,2048).sum - DelayN.ar(sig, 1, ((31 + 5) *  512 / 2 / s.sampleRate))]}.play
+
+{var sig = PlayBuf.ar(1,b.bufnum,loop:1); [FluidHPSS.ar(sig,17,29,0,0,1024,512,2048).sum - DelayN.ar(sig, 1, ((29 + 7) *  512 / 2 / s.sampleRate))]}.play
+
+{var sig = PlayBuf.ar(1,b.bufnum,loop:1); [FluidHPSS.ar(sig,17,29,0,0,1024,256,2048).sum - DelayN.ar(sig, 1, (40 *  256 / 2 / s.sampleRate))]}.play
+
+
+
+//((harmonicFilterSize + (overlap - 1)) *  hopsize)
+{var sig = PlayBuf.ar(1,b.bufnum,loop:1); [FluidHPSS.ar(sig,17,31,0,0,1024,512,2048).sum - DelayN.ar(sig, 1, (((31 + (4 - 1)) *  512) / s.sampleRate))]}.play
+
+
+
+// half harmoSize+1 * hop + window
+{var sig = PlayBuf.ar(1,b.bufnum,loop:1); [FluidHPSS.ar(sig,17,31,0,0,1024,512,2048).sum - DelayN.ar(sig, 1, ((((31+1) / 2 * 512) + 1024) / s.sampleRate))]}.play

src/FluidSines/test.scd

@@ -0,0 +1,13 @@
+s.reboot;
+
+b = Buffer.read(s,"/Users/pa/Documents/documents@hudd/research/projects/fluid corpus navigation/research/archives-2017-18/denoise_stn/sources/01-mix.wav");
+b.play
+
+// basic param
+{FluidSines.ar(PlayBuf.ar(1,b.bufnum,loop:1))}.play
+
+// sexier params
+{FluidSines.ar(PlayBuf.ar(1,b.bufnum,loop:1),windowSize:1024)}.play
+
+// null test (the process add a latency of (( hopSize * minTrackLen) + windowSize) samples
+{var sig = PlayBuf.ar(1,b.bufnum,loop:1); [FluidSines.ar(sig).sum - DelayN.ar(sig, 1, ((( 512 * 15) + 2048)/ s.sampleRate))]}.play

src/FluidTransients/test.scd

@@ -0,0 +1,12 @@
+s.reboot;
+
+b = Buffer.read(s,"/Users/pa/Documents/documents@hudd/research/projects/fluid corpus navigation/research/archives-2017-18/denoise_stn/sources/01-mix.wav");
+
+// basic param
+x = {FluidTransients.ar(PlayBuf.ar(1,b.bufnum,loop:1))}.play
+
+// sexier params
+x = {FluidTransients.ar(PlayBuf.ar(1,b.bufnum,loop:1))}.play //change to something sensible
+
+// null test (the process add a latency of (blockSize + padding - order) samples
+{var sig = PlayBuf.ar(1,b.bufnum,loop:1); [FluidTransients.ar(sig).sum - DelayN.ar(sig, 1, ((256 + 128 - 20)/ s.sampleRate))]}.play