further helpfile and class def for HPSS

release-packaging/Classes/FluidBufHPSS.sc

@@ -1,5 +1,5 @@
 FluidBufHPSS{
-		*process { arg server, srcBufNum, startAt = 0, nFrames = -1, startChan = 0, nChans = -1, harmBufNum, percBufNum, resBufNum, harmFilterSize = 17, percFilterSize = 17, modeFlag, thresholdExplanations, winSize = 4096, hopSize = 1024, fftSize = -1;
+		*process { arg server, srcBufNum, startAt = 0, nFrames = -1, startChan = 0, nChans = -1, harmBufNum, percBufNum, resBufNum, harmFiltSize = 17, percFiltSize = 17, modeFlag, htf1 = 0.1, hta1 = 0, htf2 = 0.5, hta2 = 0, ptf1 = 0.1, pta1 = 0, ptf2 = 0.5, pta2 = 0, winSize = 4096, hopSize = 1024, fftSize = -1;
 
 		if(srcBufNum.isNil) { Error("Invalid buffer").format(thisMethod.name, this.class.name).throw};
 
@@ -7,6 +7,6 @@ FluidBufHPSS{
 		harmBufNum = harmBufNum ? -1;
 		percBufNum = percBufNum ? -1;
 
-		server.sendMsg(\cmd, \BufHPSS, srcBufNum, startAt, nFrames, startChan, nChans, harmBufNum, percBufNum, percFilterSize, harmFilterSize, winSize, hopSize, fftSize);
+		server.sendMsg(\cmd, \BufHPSS, srcBufNum, startAt, nFrames, startChan, nChans, harmBufNum, percBufNum, percFiltSize, harmFiltSize, modeFlag, htf1, hta1, htf2, hta2, ptf1, pta1, ptf2, pta2, winSize, hopSize, fftSize);
 }
 }

release-packaging/Classes/FluidHPSS.sc

@@ -1,6 +1,6 @@
 FluidHPSS : MultiOutUGen {
-	*ar { arg in = 0, harmFilterSize=17, percFilterSize = 17, modeFlag=0, thresholdExplanations, winSize= 1024, hopSize= 256, fftSize= -1;
+	*ar { arg in = 0, harmFiltSize=17, percFiltSize = 17, modeFlag=0, htf1 = 0.1, hta1 = 0, htf2 = 0.5, hta2 = 0, ptf1 = 0.1, pta1 = 0, ptf2 = 0.5, pta2 = 0, winSize= 1024, hopSize= 256, fftSize= -1;
-		^this.multiNew('audio', in.asAudioRateInput(this), percFilterSize, harmFilterSize, modeFlag, thresholdExplanations, winSize, hopSize, fftSize)
+		^this.multiNew('audio', in.asAudioRateInput(this), percFiltSize, harmFiltSize, modeFlag, htf1, hta1, htf2, hta2, ptf1, pta1, ptf2, pta2, winSize, hopSize, fftSize)
 	}
 	init { arg ... theInputs;
 		inputs = theInputs;

release-packaging/HelpSource/Classes/FluidBufHPSS.schelp

@@ -48,10 +48,10 @@ ARGUMENT:: percBufNum
 ARGUMENT:: resBufNum
 	The index of the buffer where the residual component will be reconstructed in mode 2.
 
-ARGUMENT:: harmFilterSize
+ARGUMENT:: harmFiltSize
 	The size in consecutive spectral frames of the median filter for the harmonic component.
 
-ARGUMENT:: percFilterSize
+ARGUMENT:: percFiltSize
 	The size in spectral bins of the median filter for the percussive component.
 
 ARGUMENT:: modeFlag
@@ -62,8 +62,29 @@ ARGUMENT:: modeFlag
 	## 2 || Inter-dependant mode - the thresholds are independant on the harmonic and percussive component, but are then normalised to make a null sum and their difference is sent to the residual buffer.
 	::
 
-ARGUMENT:: thresholdExplanations
+ARGUMENT:: htf1
-	soon here
+	In modes 1 and 2, the frequency of the low part of the threshold for the harmonic filter.
+
+ARGUMENT:: hta1
+	In modes 1 and 2, the threshold of the low part for the harmonic filter. That threshold applies to all frequencies up to htf1.
+
+ARGUMENT:: htf2
+	In modes 1 and 2, the frequency of the hight part of the threshold for the harmonic filter.
+
+ARGUMENT:: hta2
+	In modes 1 and 2, the threshold of the high part for the harmonic filter. That threshold applies to all frequencies above htf2. The threshold between htf1 and htf2 is interpolated between hta1 and hta2.
+
+ARGUMENT:: ptf1
+	In mode 2, the frequency of the low part of the threshold for the percussive filter.
+
+ARGUMENT:: pta1
+	In mode 2, the threshold of the low part for the percussive filter. That threshold applies to all frequencies up to ptf1.
+
+ARGUMENT:: ptf2
+	In mode 2, the frequency of the hight part of the threshold for the percussive filter.
+
+ARGUMENT:: pta2
+	In mode 2, the threshold of the high part for the percussive filter. That threshold applies to all frequencies above ptf2. The threshold between ptf1 and ptf2 is interpolated between pta1 and pta2.
 
 ARGUMENT:: winSize
 	The window size. As HPSS relies on spectral frames, we need to decide what precision we give it spectrally and temporally, in line with Gabor Uncertainty principles. http://www.subsurfwiki.org/wiki/Gabor_uncertainty

release-packaging/HelpSource/Classes/FluidHPSS.schelp

@@ -16,10 +16,10 @@ METHOD:: ar
 ARGUMENT:: in
 (describe argument here)
 
-ARGUMENT:: harmFilterSize
+ARGUMENT:: harmFiltSize
 (describe argument here)
 
-ARGUMENT:: percFilterSize
+ARGUMENT:: percFiltSize
 (describe argument here)
 
 ARGUMENT:: modeFlag
@@ -30,8 +30,29 @@ ARGUMENT:: modeFlag
 	## 2 || Inter-dependant mode - the thresholds are independant on the harmonic and percussive component, but are then normalised to make a null sum and their difference is sent to the residual buffer.
 	::
 
-ARGUMENT:: thresholdExplanations
+ARGUMENT:: htf1
-	soon here
+	In modes 1 and 2, the frequency of the low part of the threshold for the harmonic filter.
+
+ARGUMENT:: hta1
+	In modes 1 and 2, the threshold of the low part for the harmonic filter. That threshold applies to all frequencies up to htf1.
+
+ARGUMENT:: htf2
+	In modes 1 and 2, the frequency of the hight part of the threshold for the harmonic filter.
+
+ARGUMENT:: hta2
+	In modes 1 and 2, the threshold of the high part for the harmonic filter. That threshold applies to all frequencies above htf2. The threshold between htf1 and htf2 is interpolated between hta1 and hta2.
+
+ARGUMENT:: ptf1
+	In mode 2, the frequency of the low part of the threshold for the percussive filter.
+
+ARGUMENT:: pta1
+	In mode 2, the threshold of the low part for the percussive filter. That threshold applies to all frequencies up to ptf1.
+
+ARGUMENT:: ptf2
+	In mode 2, the frequency of the hight part of the threshold for the percussive filter.
+
+ARGUMENT:: pta2
+	In mode 2, the threshold of the high part for the percussive filter. That threshold applies to all frequencies above ptf2. The threshold between ptf1 and ptf2 is interpolated between pta1 and pta2.
 
 ARGUMENT:: winSize
 	The window size. As HPSS relies on spectral frames, we need to decide what precision we give it spectrally and temporally, in line with Gabor Uncertainty principles. http://www.subsurfwiki.org/wiki/Gabor_uncertainty