From b687b5649da174f411fc2cebdff076a54b207fce Mon Sep 17 00:00:00 2001
From: Owen Green <gungwho@gmail.com>
Date: Thu, 25 Jun 2020 16:38:55 +0100
Subject: [PATCH] Add KMeansClient RT support

---
 include/FluidSCWrapper.hpp                    |  8 ++
 release-packaging/Classes/FluidKMeans.sc      | 11 +--
 .../Classes/FluidManipulationClient.sc        | 84 +++++++++++++++++--
 .../HelpSource/Classes/FluidKMeans.schelp     | 33 +++++++-
 src/FluidManipulation/FluidManipulation.cpp   |  2 +-
 5 files changed, 121 insertions(+), 17 deletions(-)

diff --git a/include/FluidSCWrapper.hpp b/include/FluidSCWrapper.hpp
index 6d16c28..02c053b 100644
--- a/include/FluidSCWrapper.hpp
+++ b/include/FluidSCWrapper.hpp
@@ -92,6 +92,14 @@ struct IsModel<NRTThreadingAdaptor<ClientWrapper<T>>>
   using type = typename ClientWrapper<T>::isModelObject;
 };
 
+
+template<typename T>
+struct IsModel<ClientWrapper<T>>
+{
+  using type = typename ClientWrapper<T>::isModelObject;
+};
+
+
 template<typename T>
 using IsModel_t = typename IsModel<T>::type;
 
diff --git a/release-packaging/Classes/FluidKMeans.sc b/release-packaging/Classes/FluidKMeans.sc
index 5ebd7cb..dca6794 100644
--- a/release-packaging/Classes/FluidKMeans.sc
+++ b/release-packaging/Classes/FluidKMeans.sc
@@ -1,16 +1,7 @@
-FluidKMeans : FluidManipulationClient {
+FluidKMeans : FluidDataClient {
 
 	var <>k;
 
-	*new {|server|
-		var uid = UniqueID.next;
-		^super.new(server,uid)!?{|inst|inst.init(uid);inst}
-	}
-
-	init {|uid|
-		id = uid;
-	}
-
 	fit{|dataset,k, maxIter = 100, action|
 		this.k = k;
 		this.prSendMsg(\fit,
diff --git a/release-packaging/Classes/FluidManipulationClient.sc b/release-packaging/Classes/FluidManipulationClient.sc
index 541a87e..fd0315d 100644
--- a/release-packaging/Classes/FluidManipulationClient.sc
+++ b/release-packaging/Classes/FluidManipulationClient.sc
@@ -9,6 +9,7 @@ FluidProxyUgen : UGen {
 	init { |pluginname...args|
 		this.pluginname = pluginname;
 		inputs = args++Done.none++0;
+		rate = inputs.rate;
 	}
 
 	name{
@@ -50,17 +51,23 @@ FluidManipulationClient {
 		^super.newCopyArgs(server ?? {Server.default}).baseinit(*args)
 	}
 
+	makeDef { |defName...args|
+		^SynthDef(defName,{
+			var  ugen = FluidProxyUgen.kr(this.class.name, *args);
+			this.ugen = ugen;
+			ugen
+		});
+	}
+
+	updateSynthControls {}
+
 	baseinit { |...args|
 		var makeFirstSynth,synthMsg;
 		id = UniqueID.next;
 		postit = {|x| x.postln;};
 		keepAlive = true;
 		defName = (this.class.name.asString ++ id).asSymbol;
-		def = SynthDef(defName,{
-			var  ugen = FluidProxyUgen.kr(this.class.name, *args);
-			this.ugen = ugen;
-			ugen
-		});
+		def = this.makeDef(defName,*args);
 		synth = Synth.basicNew(def.name, server);
 		synthMsg = synth.newMsg(RootNode(server));
 		def.doSend(server,synthMsg);
@@ -70,10 +77,12 @@ FluidManipulationClient {
 			if(keepAlive){
 				synth = Synth(defName,target: RootNode(server));
 				synth.onFree{clock.sched(0,onSynthFree)};
+				this.updateSynthControls;
 			}
 		};
 		CmdPeriod.add({synth = nil});
 		synth.onFree{clock.sched(0,onSynthFree)};
+		this.updateSynthControls;
 	}
 
 	free{
@@ -118,6 +127,71 @@ FluidManipulationClient {
 	}
 }
 
+FluidDataClient : FluidManipulationClient {
+
+	var <id;
+	var <inBus, <outBus;
+	var <inBuffer, <outBuffer;
+
+	*new {|server,inbus, outbus,inbuf,outbuf|
+		var uid = UniqueID.next;
+		^super.new(server,uid)!?{|inst|
+			inst.init(uid);
+			inst.inBus = inbus;
+			inst.outBus = outbus;
+			inst.inBuffer = inbuf;
+			inst.outBuffer = outbuf;
+			inst
+		}
+	}
+
+	updateSynthControls{
+		synth !? {
+			if(synth.isRunning){
+				synth.set(
+					\in, inBus !? {inBus.index} ?? {0},
+					\out, outBus !? {outBus.index} ?? {0},
+					\inBuffer,inBuffer !? {inBuffer.asUGenInput} ?? {-1},
+					\outBuffer,outBuffer !? {outBuffer.asUGenInput} ?? {-1}
+			) }
+		};
+	}
+
+	inBuffer_{|newBuffer|
+		inBuffer = newBuffer;
+		this.updateSynthControls;
+	}
+
+	outBuffer_{|newBuffer|
+		outBuffer = newBuffer;
+		this.updateSynthControls;
+	}
+
+	init {|uid|
+		id = uid;
+	}
+
+	inBus_{ |newBus|
+		inBus = newBus;
+		this.updateSynthControls;
+	}
+
+	outBus_{ |newBus|
+		outBus = newBus;
+		this.updateSynthControls;
+	}
+
+	makeDef{|defName...args|
+		^SynthDef(defName, { |in,out,inBuffer,outBuffer|
+			var  ugen = FluidProxyUgen.kr(this.class.name, T2A.ar(T2K.kr(In.ar(in))), inBuffer, outBuffer, *args);
+			this.ugen = ugen;
+			Out.kr(out,ugen);
+			ugen
+		});
+	}
+}
+
+
 FluidServerCache {
 
 	var cache;
diff --git a/release-packaging/HelpSource/Classes/FluidKMeans.schelp b/release-packaging/HelpSource/Classes/FluidKMeans.schelp
index 6912197..f635910 100644
--- a/release-packaging/HelpSource/Classes/FluidKMeans.schelp
+++ b/release-packaging/HelpSource/Classes/FluidKMeans.schelp
@@ -101,7 +101,6 @@ fork{
 		}
 	});
 
-
 // Cols of kmeans should match dataset, size is the number of clusters
 ~kmeans.cols;
 ~kmeans.size;
@@ -141,4 +140,36 @@ w.refresh;
 w.front;
 )
 
+//Querying on the server using busses and buffers:
+//This is the equivalent of predictPoint, but wholly on the server
+//FluidKMeans is accessed via its own synth, so we need to use
+//a bus to communicate with it. The inBus receives a trigger to query, using data
+//from inBuffer; a trigger is then send to outBus with the prediction in outBuffer
+(
+~ib = Bus.audio(s); // input bus must be audio (for now)
+~ob = Bus.control(s); //output bus can be kr
+~inpPoint = Buffer.alloc(s,2);
+~outPoint = Buffer.alloc(s,1);
+//Set properties on FluidKMeans:
+~kmeans.inBus_(~ib).outBus_(~ob).inBuffer_(~inpPoint).outBuffer_(~outPoint);
+)
+
+//We make two Synths. One, before FluidKMeans, generates a random point and sends
+//a trigger to query. The second, after FluidKMeans, gives us the predicted cluster //triggering upadtes from the outBus
+(
+//pitching
+{
+	var trig = Impulse.ar(10);
+	var point = [WhiteNoise.kr,WhiteNoise.kr];
+	BufWr.kr(point[0],~inpPoint,0);
+	BufWr.kr(point[1],~inpPoint,1);
+	Poll.kr(T2K.kr(trig),point,[\pointX,\pointY]);
+	Out.ar(~ib.index,[trig]);
+}.play(~kmeans.synth,addAction:\addBefore);
+//catching
+{
+	Poll.kr(In.kr(~ob),Latch.kr(BufRd.kr(1,~outPoint,0,interpolation:0),In.kr(~ob)),\cluster);
+}.play(~kmeans.synth,addAction:\addAfter);
+
+)
 ::
diff --git a/src/FluidManipulation/FluidManipulation.cpp b/src/FluidManipulation/FluidManipulation.cpp
index 4df8b6f..a2f3356 100644
--- a/src/FluidManipulation/FluidManipulation.cpp
+++ b/src/FluidManipulation/FluidManipulation.cpp
@@ -26,7 +26,7 @@ PluginLoad(FluidSTFTUGen)
   makeSCWrapper<NRTThreadedDataSetQueryClient>("FluidDataSetQuery",ft);
   makeSCWrapper<NRTThreadedLabelSetClient>("FluidLabelSet",ft);
   makeSCWrapper<NRTThreadedKDTreeClient>("FluidKDTree",ft);
-  makeSCWrapper<NRTThreadedKMeansClient>("FluidKMeans",ft);
+  makeSCWrapper<RTKMeansClient>("FluidKMeans",ft);
   makeSCWrapper<NRTThreadedKNNClassifierClient>("FluidKNNClassifier",ft);
   makeSCWrapper<NRTThreadedKNNRegressorClient>("FluidKNNRegressor",ft);
   makeSCWrapper<NRTThreadedNormalizeClient>("FluidNormalize",ft);