From 06970d4b7bcb199e4ffc0098377fc1d92b576728 Mon Sep 17 00:00:00 2001 From: Pierre Alexandre Tremblay Date: Tue, 18 Sep 2018 11:40:00 +0100 Subject: [PATCH] cleaning of arguments name and order in help files and class declaration --- release-packaging/Classes/FluidBufHPSS.sc | 4 +- release-packaging/Classes/FluidBufNMF.sc | 4 +- .../Classes/FluidBufNoveltySlice.sc | 4 +- release-packaging/Classes/FluidBufSines.sc | 4 +- .../Classes/FluidBufTransientSlice.sc | 4 +- .../Classes/FluidBufTransients.sc | 4 +- release-packaging/Classes/FluidHPSS.sc | 11 +--- release-packaging/Classes/FluidSines.sc | 4 +- .../Classes/FluidTransientSlice.sc | 4 +- release-packaging/Classes/FluidTransients.sc | 4 +- .../HelpSource/Classes/FluidBufHPSS.schelp | 8 +-- .../HelpSource/Classes/FluidBufNMF.schelp | 8 +-- .../Classes/FluidBufNoveltySlice.schelp | 2 +- .../HelpSource/Classes/FluidBufSines.schelp | 2 +- .../Classes/FluidBufTransientSlice.schelp | 4 +- .../Classes/FluidBufTransients.schelp | 4 +- .../HelpSource/Classes/FluidGain.schelp | 6 +- .../HelpSource/Classes/FluidHPSS.schelp | 57 ++++++++----------- .../HelpSource/Classes/FluidSTFTPass.schelp | 8 +-- .../HelpSource/Classes/FluidSines.schelp | 36 ++++-------- .../Classes/FluidTransientSlice.schelp | 16 +++--- .../HelpSource/Classes/FluidTransients.schelp | 32 +++-------- 22 files changed, 90 insertions(+), 140 deletions(-) diff --git a/release-packaging/Classes/FluidBufHPSS.sc b/release-packaging/Classes/FluidBufHPSS.sc index aa7e730..c12b0d3 100644 --- a/release-packaging/Classes/FluidBufHPSS.sc +++ b/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, pSize = 31, hSize = 17, modeFlag, thresholdExplanations, winSize = 4096, hopSize = 1024, fftSize = -1; + *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; 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, pSize, hSize, winSize, hopSize, fftSize); + server.sendMsg(\cmd, \BufHPSS, srcBufNum, startAt, nFrames, startChan, nChans, harmBufNum, percBufNum, percFilterSize, harmFilterSize, winSize, hopSize, fftSize); } } diff --git a/release-packaging/Classes/FluidBufNMF.sc b/release-packaging/Classes/FluidBufNMF.sc index 9f43170..d0e8b80 100644 --- a/release-packaging/Classes/FluidBufNMF.sc +++ b/release-packaging/Classes/FluidBufNMF.sc @@ -1,5 +1,5 @@ FluidBufNMF { - *process { arg server, srcBufNum, startAt = 0, nFrames = -1, startChan = 0, nChans = -1, dstBufNum, dictBufNum, dictFlag = 0, actBufNum, actFlag = 0, rank = 1, iterations = 100, sortFlag = 0, windowSize = 1024, hopSize = 256, fftSize = -1, windowType = 0, randomSeed = -1; + *process { arg server, srcBufNum, startAt = 0, nFrames = -1, startChan = 0, nChans = -1, dstBufNum, dictBufNum, dictFlag = 0, actBufNum, actFlag = 0, rank = 1, nIter = 100, sortFlag = 0, winSize = 1024, hopSize = 256, fftSize = -1, winType = 0, randSeed = -1; if(srcBufNum.isNil) { Error("Invalid buffer").format(thisMethod.name, this.class.name).throw}; @@ -8,6 +8,6 @@ FluidBufNMF { dictBufNum = dictBufNum ? -1; actBufNum = actBufNum ? -1; - server.sendMsg(\cmd, \BufNMF, srcBufNum, startAt, nFrames, startChan, nChans, dstBufNum, dictBufNum, dictFlag, actBufNum, actFlag, rank, iterations, windowSize, hopSize,fftSize); + server.sendMsg(\cmd, \BufNMF, srcBufNum, startAt, nFrames, startChan, nChans, dstBufNum, dictBufNum, dictFlag, actBufNum, actFlag, rank, nIter, winSize, hopSize,fftSize); } } \ No newline at end of file diff --git a/release-packaging/Classes/FluidBufNoveltySlice.sc b/release-packaging/Classes/FluidBufNoveltySlice.sc index 732cc5f..4869f8a 100644 --- a/release-packaging/Classes/FluidBufNoveltySlice.sc +++ b/release-packaging/Classes/FluidBufNoveltySlice.sc @@ -1,11 +1,11 @@ FluidBufNoveltySlice{ - *process { arg server, srcBufNum, startAt = 0, nFrames = -1, startChan = 0, nChans = -1, transBufNum, kernelSize = 3, threshold = 0.8, winSize = 1024, hopSize = 512, fftSize = 2048; + *process { arg server, srcBufNum, startAt = 0, nFrames = -1, startChan = 0, nChans = -1, transBufNum, kernelSize = 3, thresh = 0.8, winSize = 1024, hopSize = 512, fftSize = 2048; if(srcBufNum.isNil) { Error("Invalid buffer").format(thisMethod.name, this.class.name).throw}; if(transBufNum.isNil) { Error("Invalid buffer").format(thisMethod.name, this.class.name).throw}; server = server ? Server.default; - server.sendMsg(\cmd, \BufNoveltySlice, srcBufNum, startAt, nFrames, startChan, nChans, transBufNum, kernelSize, threshold, winSize, hopSize, fftSize); + server.sendMsg(\cmd, \BufNoveltySlice, srcBufNum, startAt, nFrames, startChan, nChans, transBufNum, kernelSize, thresh, winSize, hopSize, fftSize); } } diff --git a/release-packaging/Classes/FluidBufSines.sc b/release-packaging/Classes/FluidBufSines.sc index 4da97ad..71e4cb9 100644 --- a/release-packaging/Classes/FluidBufSines.sc +++ b/release-packaging/Classes/FluidBufSines.sc @@ -1,5 +1,5 @@ FluidBufSines{ - *process { arg server, srcBufNum, startAt = 0, nFrames = -1, startChan = 0, nChans = -1, sineBufNum, resBufNum, bandwidth = 76, threshold = 0.3, minTrackLen = 15, magWeight = 0.1, freqWeight = 1, winSize = 4096, hopSize = 1024, fftSize = 8192; + *process { arg server, srcBufNum, startAt = 0, nFrames = -1, startChan = 0, nChans = -1, sineBufNum, resBufNum, bandwidth = 76, thresh = 0.3, minTrackLen = 15, magWeight = 0.1, freqWeight = 1, winSize = 4096, hopSize = 1024, fftSize = 8192; if(srcBufNum.isNil) {Error("Invalid Buffer").format(thisMethod.name, this.class.name).throw}; @@ -7,6 +7,6 @@ FluidBufSines{ sineBufNum = sineBufNum ? -1; resBufNum = resBufNum ? -1; - server.sendMsg(\cmd, \BufSines, srcBufNum, startAt, nFrames, startChan, nChans, sineBufNum, resBufNum, bandwidth, threshold, minTrackLen, magWeight, freqWeight, winSize, hopSize, fftSize); + server.sendMsg(\cmd, \BufSines, srcBufNum, startAt, nFrames, startChan, nChans, sineBufNum, resBufNum, bandwidth, thresh, minTrackLen, magWeight, freqWeight, winSize, hopSize, fftSize); } } diff --git a/release-packaging/Classes/FluidBufTransientSlice.sc b/release-packaging/Classes/FluidBufTransientSlice.sc index 466c934..bdda702 100644 --- a/release-packaging/Classes/FluidBufTransientSlice.sc +++ b/release-packaging/Classes/FluidBufTransientSlice.sc @@ -1,11 +1,11 @@ FluidBufTransientSlice{ - *process { arg server, srcBufNum, startAt = 0, nFrames = -1, startChan = 0, nChans = -1, transBufNum, order = 200, blockSize = 2048, padding = 1024, skew = 0, threshFwd = 3, threshBack = 1.1, windowSize = 14, debounce = 25; + *process { arg server, srcBufNum, startAt = 0, nFrames = -1, startChan = 0, nChans = -1, transBufNum, order = 200, blockSize = 2048, padSize = 1024, skew = 0, threshFwd = 3, threshBack = 1.1, winSize = 14, debounce = 25; if(srcBufNum.isNil) { Error("Invalid buffer").format(thisMethod.name, this.class.name).throw}; if(transBufNum.isNil) { Error("Invalid buffer").format(thisMethod.name, this.class.name).throw}; server = server ? Server.default; - server.sendMsg(\cmd, \BufTransientSlice, srcBufNum, startAt, nFrames, startChan, nChans, transBufNum, order, blockSize, padding, skew, threshFwd, threshBack, windowSize, debounce); + server.sendMsg(\cmd, \BufTransientSlice, srcBufNum, startAt, nFrames, startChan, nChans, transBufNum, order, blockSize, padSize, skew, threshFwd, threshBack, winSize, debounce); } } diff --git a/release-packaging/Classes/FluidBufTransients.sc b/release-packaging/Classes/FluidBufTransients.sc index a3f72c5..beb01b6 100644 --- a/release-packaging/Classes/FluidBufTransients.sc +++ b/release-packaging/Classes/FluidBufTransients.sc @@ -1,5 +1,5 @@ FluidBufTransients { - *process { arg server, srcBufNum, startAt = 0, nFrames = -1, startChan = 0, nChans = -1, transBufNum, resBufNum, order = 200, blockSize = 2048, padding = 1024, skew = 0, threshFwd = 3, threshBack = 1.1, windowSize = 14, debounce = 25; + *process { arg server, srcBufNum, startAt = 0, nFrames = -1, startChan = 0, nChans = -1, transBufNum, resBufNum, order = 200, blockSize = 2048, padSize = 1024, skew = 0, threshFwd = 3, threshBack = 1.1, winSize = 14, debounce = 25; if(srcBufNum.isNil) { Error("Invalid buffer").format(thisMethod.name, this.class.name).throw}; @@ -7,6 +7,6 @@ FluidBufTransients { transBufNum = transBufNum ? -1; resBufNum = resBufNum ? -1; - server.sendMsg(\cmd, \BufTransients, srcBufNum, startAt, nFrames, startChan, nChans, transBufNum, resBufNum, order, blockSize, padding, skew, threshFwd, threshBack, windowSize, debounce); + server.sendMsg(\cmd, \BufTransients, srcBufNum, startAt, nFrames, startChan, nChans, transBufNum, resBufNum, order, blockSize, padSize, skew, threshFwd, threshBack, winSize, debounce); } } \ No newline at end of file diff --git a/release-packaging/Classes/FluidHPSS.sc b/release-packaging/Classes/FluidHPSS.sc index 7633063..e63ccf7 100644 --- a/release-packaging/Classes/FluidHPSS.sc +++ b/release-packaging/Classes/FluidHPSS.sc @@ -1,13 +1,6 @@ FluidHPSS : MultiOutUGen { - *ar { arg in = 0, percussiveFilterSize = 17, harmonicFilterSize=17, harmonicBinaryMask=0, percussiveBinaryMask=0, - percussiveThreshFreq1=0, percussiveThreshAmp1=0,percussiveThreshFreq2=1.0, percussiveThreshAmp2=0, - harmonicThreshFreq1=0, harmonicThreshAmp1=0, harmonicThreshFreq2=1.0, harmonicThreshAmp2=0, - windowSize= 1024, hopSize= 256, fftSize= -1; - ^this.multiNew('audio', in.asAudioRateInput(this), percussiveFilterSize, harmonicFilterSize, - harmonicBinaryMask,percussiveBinaryMask, - percussiveThreshFreq1, percussiveThreshAmp1,percussiveThreshFreq2, percussiveThreshAmp2, - harmonicThreshFreq1, harmonicThreshAmp1, harmonicThreshFreq2, harmonicThreshAmp2, - windowSize, hopSize, fftSize) + *ar { arg in = 0, harmFilterSize=17, percFilterSize = 17, modeFlag=0, thresholdExplanations, winSize= 1024, hopSize= 256, fftSize= -1; + ^this.multiNew('audio', in.asAudioRateInput(this), percFilterSize, harmFilterSize, modeFlag, thresholdExplanations, winSize, hopSize, fftSize) } init { arg ... theInputs; inputs = theInputs; diff --git a/release-packaging/Classes/FluidSines.sc b/release-packaging/Classes/FluidSines.sc index ded6845..f2c377b 100644 --- a/release-packaging/Classes/FluidSines.sc +++ b/release-packaging/Classes/FluidSines.sc @@ -1,6 +1,6 @@ FluidSines : MultiOutUGen { - *ar { arg in = 0, bandwidth = 76, threshold = 0.7, minTrackLen = 15, magnitudeWeight = 0.1, frequencyWeight = 1.0, windowSize= 2048, hopSize= 512, fftSize= 8192; - ^this.multiNew('audio', in.asAudioRateInput(this), bandwidth, threshold, minTrackLen, magnitudeWeight,frequencyWeight ,windowSize, hopSize, fftSize) + *ar { arg in = 0, bandwidth = 76, thresh = 0.7, minTrackLen = 15, magWeight = 0.1, freqWeight = 1.0, winSize= 2048, hopSize= 512, fftSize= 8192; + ^this.multiNew('audio', in.asAudioRateInput(this), bandwidth, thresh, minTrackLen, magWeight,freqWeight ,winSize, hopSize, fftSize) } init { arg ... theInputs; inputs = theInputs; diff --git a/release-packaging/Classes/FluidTransientSlice.sc b/release-packaging/Classes/FluidTransientSlice.sc index 39aca04..5ef269a 100644 --- a/release-packaging/Classes/FluidTransientSlice.sc +++ b/release-packaging/Classes/FluidTransientSlice.sc @@ -1,5 +1,5 @@ FluidTransientSlice : UGen { - *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) + *ar { arg in = 0, order = 20, blockSize = 256, padSize = 128, skew = 0.0, threshFwd = 3.0, threshBack = 1.1, winSize=14, debounce=25; + ^this.multiNew('audio', in.asAudioRateInput(this), order, blockSize, padSize, skew, threshFwd ,threshBack, winSize, debounce) } } \ No newline at end of file diff --git a/release-packaging/Classes/FluidTransients.sc b/release-packaging/Classes/FluidTransients.sc index e6f935b..0c96de7 100644 --- a/release-packaging/Classes/FluidTransients.sc +++ b/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; - ^this.multiNew('audio', in.asAudioRateInput(this), order, blockSize, padding, skew,threshFwd ,threshBack, winSize,debounce) + *ar { arg in = 0, order = 20, blockSize = 256, padSize = 128, skew = 0.0, threshFwd = 3.0, threshBack = 1.1, winSize=14, debounce=25; + ^this.multiNew('audio', in.asAudioRateInput(this), order, blockSize, padSize, skew,threshFwd ,threshBack, winSize,debounce) } init { arg ... theInputs; inputs = theInputs; diff --git a/release-packaging/HelpSource/Classes/FluidBufHPSS.schelp b/release-packaging/HelpSource/Classes/FluidBufHPSS.schelp index 86b1b84..e9d4523 100644 --- a/release-packaging/HelpSource/Classes/FluidBufHPSS.schelp +++ b/release-packaging/HelpSource/Classes/FluidBufHPSS.schelp @@ -48,12 +48,12 @@ ARGUMENT:: percBufNum ARGUMENT:: resBufNum The index of the buffer where the residual component will be reconstructed in mode 2. -ARGUMENT:: pSize - The size in spectral bins of the median filter for the percussive component. - -ARGUMENT:: hSize +ARGUMENT:: harmFilterSize The size in consecutive spectral frames of the median filter for the harmonic component. +ARGUMENT:: percFilterSize + The size in spectral bins of the median filter for the percussive component. + ARGUMENT:: modeFlag The way the masking is happening on the spectrogram. table:: diff --git a/release-packaging/HelpSource/Classes/FluidBufNMF.schelp b/release-packaging/HelpSource/Classes/FluidBufNMF.schelp index 297f98f..0556b84 100644 --- a/release-packaging/HelpSource/Classes/FluidBufNMF.schelp +++ b/release-packaging/HelpSource/Classes/FluidBufNMF.schelp @@ -67,13 +67,13 @@ ARGUMENT:: actFlag ARGUMENT:: rank The number of elements the NMF algorythim will try to divide the spectrogram of the source in. -ARGUMENT:: iterations +ARGUMENT:: nIter The NMF process is iterative, trying to converge to the smallest error in its factorisation. The number of iterations will decide how many times it tries to adjust its guestimates. Higher numbers here will be more CPU expensive, lower numbers will be more unpredictable in quality. ARGUMENT:: sortFlag This allows to choose between the different methods of sorting the ranks in order to get similar sonic qualities on a given rank (not implemented yet) -ARGUMENT:: windowSize +ARGUMENT:: winSize The window size. As NMF 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 ARGUMENT:: hopSize @@ -82,10 +82,10 @@ ARGUMENT:: hopSize ARGUMENT:: fftSize The inner FFT/IFFT size. It should be at least 4 samples long, at least the size of the window, and a power of 2. Making it larger allows an oversampling of the spectral precision. -ARGUMENT:: windowType +ARGUMENT:: winType The inner FFT/IFFT windowing type (not implemented yet) -ARGUMENT:: randomSeed +ARGUMENT:: randSeed The NMF process needs to seed its starting point. If specified, the same values will be used. The default of -1 will randomly assign them. (not implemented yet) RETURNS:: diff --git a/release-packaging/HelpSource/Classes/FluidBufNoveltySlice.schelp b/release-packaging/HelpSource/Classes/FluidBufNoveltySlice.schelp index b036287..a24649f 100644 --- a/release-packaging/HelpSource/Classes/FluidBufNoveltySlice.schelp +++ b/release-packaging/HelpSource/Classes/FluidBufNoveltySlice.schelp @@ -39,7 +39,7 @@ ARGUMENT:: transBufNum ARGUMENT:: kernelSize The granularity of the window in which the algorithm looks for change, in samples. A small number will be sensitive to short term changes, and a large number should look for long term changes. -ARGUMENT:: threshold +ARGUMENT:: thresh The threshold in the novelty curve, the latter being derived from running the kernel across the diagonal of the similarity matrix, and looking for peak of changes (NOT CLEAR) ARGUMENT:: winSize diff --git a/release-packaging/HelpSource/Classes/FluidBufSines.schelp b/release-packaging/HelpSource/Classes/FluidBufSines.schelp index 45a843e..fe5c430 100644 --- a/release-packaging/HelpSource/Classes/FluidBufSines.schelp +++ b/release-packaging/HelpSource/Classes/FluidBufSines.schelp @@ -45,7 +45,7 @@ ARGUMENT:: resBufNum ARGUMENT:: bandwidth The width in bins (OR IN PERCENT IN NEW INTERFACE) of the fragment of the fft window that is considered a normal deviation for a potential continuous sinusoidal track. It has an effect on CPU cost: the widest is more accurate but more computationally expensive. -ARGUMENT:: threshold +ARGUMENT:: thresh The normalised threshold, between 0 an 1, to consider a peak as a sinusoidal component from the normalized cross-correlation. ARGUMENT:: minTrackLen diff --git a/release-packaging/HelpSource/Classes/FluidBufTransientSlice.schelp b/release-packaging/HelpSource/Classes/FluidBufTransientSlice.schelp index e6519c1..824b983 100644 --- a/release-packaging/HelpSource/Classes/FluidBufTransientSlice.schelp +++ b/release-packaging/HelpSource/Classes/FluidBufTransientSlice.schelp @@ -42,7 +42,7 @@ ARGUMENT:: order ARGUMENT:: blockSize The size in samples of frame on which it the algorithm is operating. High values are more cpu intensive, and also determines the maximum transient size, which will not be allowed to be more than half that lenght in size. -ARGUMENT:: padding +ARGUMENT:: padSize The size of the handles on each sides of the block simply used for analysis purpose and avoid boundary issues. ARGUMENT:: skew @@ -54,7 +54,7 @@ ARGUMENT:: threshFwd ARGUMENT:: threshBack The threshold of the offset of the smoothed error function. As it proceeds backwards in time, it allows tight ending of the identification of the anomaly. -ARGUMENT:: windowSize +ARGUMENT:: winSize The averaging window of the error detection function. It needs smoothing as it is very jittery. The longer the window, the less precise, but the less false positive. ARGUMENT:: debounce diff --git a/release-packaging/HelpSource/Classes/FluidBufTransients.schelp b/release-packaging/HelpSource/Classes/FluidBufTransients.schelp index 479b47b..0dfc0e3 100644 --- a/release-packaging/HelpSource/Classes/FluidBufTransients.schelp +++ b/release-packaging/HelpSource/Classes/FluidBufTransients.schelp @@ -50,7 +50,7 @@ ARGUMENT:: order ARGUMENT:: blockSize The size in samples of frame on which it the algorithm is operating. High values are more cpu intensive, and also determines the maximum transient size, which will not be allowed to be more than half that lenght in size. -ARGUMENT:: padding +ARGUMENT:: padSize The size of the handles on each sides of the block simply used for analysis purpose and avoid boundary issues. ARGUMENT:: skew @@ -62,7 +62,7 @@ ARGUMENT:: threshFwd ARGUMENT:: threshBack The threshold of the offset of the smoothed error function. As it proceeds backwards in time, it allows tight ending of the identification of the anomaly. -ARGUMENT:: windowSize +ARGUMENT:: winSize The averaging window of the error detection function. It needs smoothing as it is very jittery. The longer the window, the less precise, but the less false positive. ARGUMENT:: debounce diff --git a/release-packaging/HelpSource/Classes/FluidGain.schelp b/release-packaging/HelpSource/Classes/FluidGain.schelp index 78f314f..9489a77 100644 --- a/release-packaging/HelpSource/Classes/FluidGain.schelp +++ b/release-packaging/HelpSource/Classes/FluidGain.schelp @@ -28,14 +28,14 @@ RETURNS:: EXAMPLES:: Summing with the inverse (gain of -1) with a delay of the latency gives us CPU-expensive silence. - code:: + CODE:: { var source = PinkNoise.ar(0.1); DelayN.ar(source,delaytime:1000/s.sampleRate) + FluidGain.ar(source,1000,-1); }.play :: Varying the gain at audio rate. - code:: + CODE:: { FluidGain.ar(PinkNoise.ar(0.1), gain:LFTri.ar(1)) }.play :: Varying the gain at comtrol rate, in beautiful stereo. - code:: + CODE:: { FluidGain.ar(SinOsc.ar([222,333],mul:0.1), gain:LFTri.kr([0.5,0.7])) }.play :: diff --git a/release-packaging/HelpSource/Classes/FluidHPSS.schelp b/release-packaging/HelpSource/Classes/FluidHPSS.schelp index 078d710..dfd49e7 100644 --- a/release-packaging/HelpSource/Classes/FluidHPSS.schelp +++ b/release-packaging/HelpSource/Classes/FluidHPSS.schelp @@ -1,11 +1,11 @@ TITLE:: FluidHPSS -summary:: (put short description here) -categories:: Libraries>FluidDecomposition -related:: Guides/FluCoMa, Guides/FluidDecomposition +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).:: +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:: @@ -16,48 +16,37 @@ METHOD:: ar ARGUMENT:: in (describe argument here) -ARGUMENT:: percussiveFilterSize +ARGUMENT:: harmFilterSize (describe argument here) -ARGUMENT:: harmonicFilterSize +ARGUMENT:: percFilterSize (describe argument here) -ARGUMENT:: percussiveThreshold -(describe argument here) +ARGUMENT:: modeFlag + The way the masking is happening on the spectrogram. + table:: + ## 0 || Original paper - the loudest winds. + ## 1 || Relative mode - the thresholds set next on the harmonic counterpart will decide of a binary masking, and the percussive mask is its complement. + ## 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:: harmonicThreshold -(describe argument here) +ARGUMENT:: thresholdExplanations + soon here -ARGUMENT:: windowSize -(describe argument here) +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 ARGUMENT:: hopSize -(describe argument here) + The window hope size. As HPSS relies on spectral frames, we need to move the window forward. It can be any size but low overlap will create audible artefacts. 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) + The inner FFT/IFFT size. It should be at least 4 samples long, at least the size of the window, and a power of 2. Making it larger allows an oversampling of the spectral precision. +RETURNS:: +(describe returnvalue here) EXAMPLES:: -code:: - +CODE:: +safdsad :: \ No newline at end of file diff --git a/release-packaging/HelpSource/Classes/FluidSTFTPass.schelp b/release-packaging/HelpSource/Classes/FluidSTFTPass.schelp index c2f4a61..7a51887 100644 --- a/release-packaging/HelpSource/Classes/FluidSTFTPass.schelp +++ b/release-packaging/HelpSource/Classes/FluidSTFTPass.schelp @@ -32,18 +32,18 @@ RETURNS:: EXAMPLES:: Summing with the inverse (gain of -1) with a delay of the latency gives us CPU-expensive silence. - code:: + CODE:: { var source = PinkNoise.ar(0.1); DelayN.ar(source, delaytime:1024/s.sampleRate, mul: -1) + FluidSTFTPass.ar(source, 1024, 256, 1024); }.play :: Larger, oversampled, FFT - code:: + CODE:: { FluidSTFTPass.ar(PinkNoise.ar(0.1), 2048, 128, 8192) }.play :: Stereo Input Tests. - code:: + CODE:: { FluidSTFTPass.ar([SinOsc.ar(222,mul: 0.1), PinkNoise.ar(Decay.ar(Impulse.ar(0.666,mul: 0.2), 0.5))], fftSize:1024)}.play :: Stereo Parameter Tests. - code:: + CODE:: { FluidSTFTPass.ar(SinOsc.ar(222,mul: 0.1), [1024,8192],256,8192)}.play :: diff --git a/release-packaging/HelpSource/Classes/FluidSines.schelp b/release-packaging/HelpSource/Classes/FluidSines.schelp index 4d15282..f3e28bb 100644 --- a/release-packaging/HelpSource/Classes/FluidSines.schelp +++ b/release-packaging/HelpSource/Classes/FluidSines.schelp @@ -1,11 +1,11 @@ TITLE:: FluidSines -summary:: (put short description here) -categories:: Libraries>FluidDecomposition -related:: Guides/FluCoMa, Guides/FluidDecomposition +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).:: +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:: @@ -19,19 +19,19 @@ ARGUMENT:: in ARGUMENT:: bandwidth (describe argument here) -ARGUMENT:: threshold +ARGUMENT:: thresh (describe argument here) ARGUMENT:: minTrackLen (describe argument here) -ARGUMENT:: magnitudeWeight +ARGUMENT:: magWeight (describe argument here) -ARGUMENT:: frequencyWeight +ARGUMENT:: freqWeight (describe argument here) -ARGUMENT:: windowSize +ARGUMENT:: winSize (describe argument here) ARGUMENT:: hopSize @@ -40,27 +40,11 @@ ARGUMENT:: hopSize 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) +RETURNS:: (describe returnvalue here) EXAMPLES:: -code:: +CODE:: (some example code) :: \ No newline at end of file diff --git a/release-packaging/HelpSource/Classes/FluidTransientSlice.schelp b/release-packaging/HelpSource/Classes/FluidTransientSlice.schelp index 9e95102..dc2a147 100644 --- a/release-packaging/HelpSource/Classes/FluidTransientSlice.schelp +++ b/release-packaging/HelpSource/Classes/FluidTransientSlice.schelp @@ -1,11 +1,11 @@ TITLE:: FluidTransientSlice -summary:: (put short description here) -categories:: Libraries>FluidDecomposition -related:: Guides/FluCoMa, Guides/FluidDecomposition +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).:: +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:: @@ -18,10 +18,10 @@ ARGUMENT:: in ARGUMENT:: order (describe argument here) -ARGUMENT:: blocksize +ARGUMENT:: blockSize (describe argument here) -ARGUMENT:: padding +ARGUMENT:: padSize (describe argument here) ARGUMENT:: skew @@ -39,7 +39,7 @@ ARGUMENT:: winSize ARGUMENT:: debounce (describe argument here) -returns:: (describe returnvalue here) +RETURNS:: (describe returnvalue here) INSTANCEMETHODS:: @@ -47,6 +47,6 @@ INSTANCEMETHODS:: EXAMPLES:: -code:: +CODE:: (some example code) :: \ No newline at end of file diff --git a/release-packaging/HelpSource/Classes/FluidTransients.schelp b/release-packaging/HelpSource/Classes/FluidTransients.schelp index 214f227..9db5afd 100644 --- a/release-packaging/HelpSource/Classes/FluidTransients.schelp +++ b/release-packaging/HelpSource/Classes/FluidTransients.schelp @@ -1,11 +1,11 @@ TITLE:: FluidTransients -summary:: (put short description here) -categories:: Libraries>FluidDecomposition -related:: Guides/FluCoMa, Guides/FluidDecomposition +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).:: +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:: @@ -22,7 +22,7 @@ ARGUMENT:: order ARGUMENT:: blockSize (describe argument here) -ARGUMENT:: padding +ARGUMENT:: padSize (describe argument here) ARGUMENT:: skew @@ -40,27 +40,11 @@ ARGUMENT:: winSize 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) - +RETURNS:: + (describe returnvalue here) EXAMPLES:: -code:: +CODE:: (some example code) :: \ No newline at end of file