diff --git a/release-packaging/HelpSource/Classes/FluidBufSines.schelp b/release-packaging/HelpSource/Classes/FluidBufSines.schelp index fe5c430..d25506b 100644 --- a/release-packaging/HelpSource/Classes/FluidBufSines.schelp +++ b/release-packaging/HelpSource/Classes/FluidBufSines.schelp @@ -72,7 +72,30 @@ RETURNS:: EXAMPLES:: code:: - b = Buffer.read(s,"../../../AudioFiles/01-mix.wav".resolveRelative); - b.play +// create some buffers +( +b = Buffer.read(s,"../../AudioFiles/Tremblay-AaS-SynthTwoVoices-M.wav".resolveRelative); +c = Buffer.new(s); +d = Buffer.new(s); +) + +// run the process with basic parameters +( +Routine{ + t = Main.elapsedTime; + FluidBufSines.process(s, b.bufnum, sineBufNum: c.bufnum, resBufNum:d.bufnum); + s.sync; + (Main.elapsedTime - t).postln; +}.play +) + +// listen to each component +c.query; +c.play; +d.query; +d.play; + +//nullsumming tests +{(PlayBuf.ar(1,c.bufnum))+(PlayBuf.ar(1,d.bufnum))-(PlayBuf.ar(1,b.bufnum,doneAction:2))}.play :: \ No newline at end of file diff --git a/release-packaging/HelpSource/Classes/FluidSines.schelp b/release-packaging/HelpSource/Classes/FluidSines.schelp index 8e477aa..966586f 100644 --- a/release-packaging/HelpSource/Classes/FluidSines.schelp +++ b/release-packaging/HelpSource/Classes/FluidSines.schelp @@ -1,11 +1,16 @@ TITLE:: FluidSines -SUMMARY:: (put short description here) +SUMMARY:: Sinusoidal Modelling and Resynthesis 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 class applies a Sinusoidal Modelling process on its audio input. It implements a mix and match algorithms taken from classic papers. 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).:: + + The algorithm will take an audio in, and will divide it in two parts: LIST:: + ## a reconstruction of what its detects as sinusoidal; + ## a residual derived from the previous buffert to allow null-summing:: + + The whole process is based on the assumption that signal is made of pitched steady components that have a long-enough duration and are periodic enough to be perceived as such, that can be tracked, resynthesised and removed from the original, leaving behind what is considered as non-pitched, noisy, and/or transient. It first tracks the peaks, then checks if they are the continuation of a peak in previous spectral frames, by assigning them a track. More information on this model, and on how it links to musicianly thinking, are availabe in LINK::Guides/FluCoMa:: overview file. CLASSMETHODS:: @@ -14,31 +19,32 @@ METHOD:: ar The audio rate version of the object. ARGUMENT:: in -(describe argument here) + The input to be processed ARGUMENT:: bandwidth -(describe argument here) + 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:: thresh -(describe argument here) + The normalised threshold, between 0 an 1, to consider a peak as a sinusoidal component from the normalized cross-correlation. ARGUMENT:: minTrackLen -(describe argument here) + The minimum duration, in spectral frames, for a sinusoidal track to be accepted as a real pitch component. It allows to remove space-monkeys, but is more CPU intensive and might reject quick pitch material. ARGUMENT:: magWeight -(describe argument here) + The weight of the magnitude proximity of a peak when trying to associate it to an existing track (relative to freqWeight - suggested between 0 to 1) ARGUMENT:: freqWeight -(describe argument here) + The weight of the frequency proximity of a peak when trying to associate it to an existing track (relative to magWeight - suggested between 0 to 1) ARGUMENT:: winSize -(describe argument here) + The window size. As sinusoidal estimation 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 sinusoidal estimation 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) + 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:: An array of two audio streams: [0] is the harmonic part extracted, [1] is the rest. The latency between the input and the output is (( hopSize * minTrackLen) + windowSize) samples. @@ -47,5 +53,16 @@ RETURNS:: EXAMPLES:: CODE:: -(some example code) +// load some audio to play +b = Buffer.read(s,"../../AudioFiles/Tremblay-AaS-SynthTwoVoices-M.wav".resolveRelative); + +// run with basic parameters - left is sinusoidal model, right is residual +{FluidSines.ar(PlayBuf.ar(1,b.bufnum,loop:1))}.play + +// interactive parameters with a narrower bandwidth +{FluidSines.ar(PlayBuf.ar(1,b.bufnum,loop:1),30,MouseX.kr(),5)}.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 + :: \ No newline at end of file