From 3f687e238ae4280c574146c4403555bdc7fdaa6f Mon Sep 17 00:00:00 2001 From: Pierre Alexandre Tremblay Date: Sun, 19 Jul 2020 12:37:37 +0100 Subject: [PATCH 1/2] FluidBufNNDSVD is a thing --- release-packaging/Classes/FluidBufNNDSVD.sc | 35 +++++++++++ .../HelpSource/Classes/FluidBufNNDSVD.schelp | 61 +++++++++++++++++++ src/FluidBufNNDSVD/CMakeLists.txt | 21 +++++++ src/FluidBufNNDSVD/FluidBufNNDSVD.cpp | 22 +++++++ 4 files changed, 139 insertions(+) create mode 100644 release-packaging/Classes/FluidBufNNDSVD.sc create mode 100644 release-packaging/HelpSource/Classes/FluidBufNNDSVD.schelp create mode 100644 src/FluidBufNNDSVD/CMakeLists.txt create mode 100644 src/FluidBufNNDSVD/FluidBufNNDSVD.cpp diff --git a/release-packaging/Classes/FluidBufNNDSVD.sc b/release-packaging/Classes/FluidBufNNDSVD.sc new file mode 100644 index 0000000..12fe6d3 --- /dev/null +++ b/release-packaging/Classes/FluidBufNNDSVD.sc @@ -0,0 +1,35 @@ +FluidBufNNDSVD : UGen{ + *new1 { |rate, source, bases, activations, minComponents = 1, maxComponents = 200, coverage = 0.5, method = 0, windowSize = 1024, hopSize = -1, fftSize = -1, trig = 1, blocking=0| + + source.isNil.if {"FluidBufNNDSVD: Invalid source buffer".throw}; + bases.isNil.if {"FluidBufNNDSVD: Invalid bases buffer".throw}; + activations.isNil.if {"FluidBufNNDSVD: Invalid bases buffer".throw}; + source = source.asUGenInput; + bases = bases.asUGenInput; + activations = activations.asUGenInput; + + ^super.new1(rate, source, bases, activations, minComponents, maxComponents, coverage, method, windowSize, hopSize, fftSize, trig, blocking) + + } + + *kr { |source, bases, activations, minComponents = 1, maxComponents = 200, coverage = 0.5, method = 0, windowSize = 1024, hopSize = -1, fftSize = -1, trig = 1| + ^this.new1(\control, source, bases, activations, minComponents, maxComponents, coverage, method, windowSize, hopSize, fftSize, trig); + } + + + *process { |server, source, bases, activations, minComponents = 1, maxComponents = 200, coverage = 0.5, method = 0, windowSize = 1024, hopSize = -1, fftSize = -1, action| + ^FluidNRTProcess.new( + server, this, action, [bases] + ).process( + source, bases, activations, minComponents, maxComponents, coverage, method, windowSize, hopSize, fftSize + ) + } + + *processBlocking { |server, source, bases, activations, minComponents = 1, maxComponents = 200, coverage = 0.5, method = 0, windowSize = 1024, hopSize = -1, fftSize = -1, action| + ^FluidNRTProcess.new( + server, this, action, [bases],blocking:1 + ).process( + source, bases, activations, minComponents, maxComponents, coverage, method, windowSize, hopSize, fftSize + ) + } +} diff --git a/release-packaging/HelpSource/Classes/FluidBufNNDSVD.schelp b/release-packaging/HelpSource/Classes/FluidBufNNDSVD.schelp new file mode 100644 index 0000000..c4a8ec2 --- /dev/null +++ b/release-packaging/HelpSource/Classes/FluidBufNNDSVD.schelp @@ -0,0 +1,61 @@ +TITLE:: FluidBufNNDSVD +summary:: something +categories:: FluidManipulation +related:: Classes/FluidBufNMF + +DESCRIPTION:: +does something + +See +a paper + +CLASSMETHODS:: + +METHOD:: process +Process two audio link::Classes/Buffer:: + +ARGUMENT:: server +The server the process runs on + +ARGUMENT:: source +(describe argument here) + +ARGUMENT:: bases +(describe argument here) + +ARGUMENT:: activations +(describe argument here) + +ARGUMENT:: minComponents +(describe argument here) + +ARGUMENT:: maxComponents +(describe argument here) + +ARGUMENT:: coverage +(describe argument here) + +ARGUMENT:: method +(describe argument here) + +ARGUMENT:: windowSize + The window size. As spectral differencing 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 + The window hop 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. The -1 default value will default to half of windowSize (overlap of 2). + +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. The -1 default value will use the next power of 2 equal or above the highest of windowSize and (bandwidth - 1) * 2. + +ARGUMENT:: action + A Function to be evaluated once the offline process has finished and all Buffer's instance variables have been updated on the client side. The function will be passed [destination] as an argument. + +INSTANCEMETHODS:: + +private:: synth, server + +EXAMPLES:: + +code:: +yes +:: diff --git a/src/FluidBufNNDSVD/CMakeLists.txt b/src/FluidBufNNDSVD/CMakeLists.txt new file mode 100644 index 0000000..9646a4e --- /dev/null +++ b/src/FluidBufNNDSVD/CMakeLists.txt @@ -0,0 +1,21 @@ +# Part of the Fluid Corpus Manipulation Project (http://www.flucoma.org/) +# Copyright 2017-2019 University of Huddersfield. +# Licensed under the BSD-3 License. +# See license.md file in the project root for full license information. +# This project has received funding from the European Research Council (ERC) +# under the European Union’s Horizon 2020 research and innovation programme +# (grant agreement No 725899). + +cmake_minimum_required(VERSION 3.11) + +get_filename_component(PLUGIN ${CMAKE_CURRENT_LIST_DIR} NAME_WE) +message("Configuring ${PLUGIN}") +set(FILENAME ${PLUGIN}.cpp) + +add_library( + ${PLUGIN} + MODULE + ${FILENAME} +) + +include(${CMAKE_CURRENT_LIST_DIR}/../../scripts/target_post.cmake) diff --git a/src/FluidBufNNDSVD/FluidBufNNDSVD.cpp b/src/FluidBufNNDSVD/FluidBufNNDSVD.cpp new file mode 100644 index 0000000..2f4e47f --- /dev/null +++ b/src/FluidBufNNDSVD/FluidBufNNDSVD.cpp @@ -0,0 +1,22 @@ +/* +Part of the Fluid Corpus Manipulation Project (http://www.flucoma.org/) +Copyright 2017-2019 University of Huddersfield. +Licensed under the BSD-3 License. +See license.md file in the project root for full license information. +This project has received funding from the European Research Council (ERC) +under the European Union’s Horizon 2020 research and innovation programme +(grant agreement No 725899). +*/ + +#include + +#include + +static InterfaceTable *ft; + +PluginLoad(FluidSTFTUGen) +{ + ft = inTable; + using namespace fluid::client; + makeSCWrapper("FluidBufNNDSVD", ft); +} From 31435d5118ba389d155c29ebcc5d45dfb2b74424 Mon Sep 17 00:00:00 2001 From: Pierre Alexandre Tremblay Date: Sun, 19 Jul 2020 13:53:19 +0100 Subject: [PATCH 2/2] now with words and example --- .../HelpSource/Classes/FluidBufNNDSVD.schelp | 54 ++++++++++++++----- 1 file changed, 40 insertions(+), 14 deletions(-) diff --git a/release-packaging/HelpSource/Classes/FluidBufNNDSVD.schelp b/release-packaging/HelpSource/Classes/FluidBufNNDSVD.schelp index c4a8ec2..c8476c9 100644 --- a/release-packaging/HelpSource/Classes/FluidBufNNDSVD.schelp +++ b/release-packaging/HelpSource/Classes/FluidBufNNDSVD.schelp @@ -1,42 +1,48 @@ TITLE:: FluidBufNNDSVD -summary:: something +summary:: Non-Negative Double Singular Value Decomposition on a Buffer categories:: FluidManipulation related:: Classes/FluidBufNMF DESCRIPTION:: -does something +Find Initial Bases and Activations for FluidBufNMF via Non-Negative Double Singular Value Decomposition . -See -a paper +See http://nimfa.biolab.si/nimfa.methods.seeding.nndsvd.html CLASSMETHODS:: METHOD:: process -Process two audio link::Classes/Buffer:: +This is the method that calls for the decomposition to be calculated on a given source buffer. ARGUMENT:: server -The server the process runs on +The server on which the buffers to be processed are allocated. ARGUMENT:: source -(describe argument here) +The index of the buffer to use as the source material to be decomposed through the NMF process. The different channels of multichannel buffers will be processing sequentially. ARGUMENT:: bases -(describe argument here) +The index of the buffer where the different bases will be written to and/or read from: the behaviour is set in the following argument. ARGUMENT:: activations -(describe argument here) +The index of the buffer where the different activations will be written to and/or read from: the behaviour is set in the following argument. ARGUMENT:: minComponents -(describe argument here) +Minimum number of estimated components ARGUMENT:: maxComponents -(describe argument here) +Maximum number of estimated components ARGUMENT:: coverage -(describe argument here) +Fraction (0 to 1) of information preserved in the decomposition ARGUMENT:: method -(describe argument here) +The method used for the decomposition. Options are: + +table:: +## 0 || NMF-SVD || faster +## 1 || NNDSVDar || more accurate, fill in the zero elements with random values +## 2 || NNDSVDa || fill in the zero elements with the average +## 3 || NNDSVD || leave zero elements as zero, works better for sparse spectrograms +:: ARGUMENT:: windowSize The window size. As spectral differencing 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 @@ -57,5 +63,25 @@ private:: synth, server EXAMPLES:: code:: -yes +( +b = Buffer.read(s,File.realpath(FluidBufNNDSVD.class.filenameSymbol).dirname.withTrailingSlash ++ "../AudioFiles/Nicol-LoopE-M.wav"); +~bases = Buffer.new(s); +~activations = Buffer.new(s); +~resynth = Buffer.new(s); +) + +//how many bases do I need to decompose the buffer with 90% accuracy +FluidBufNNDSVD.process(s, b, ~bases, ~activations, coverage: 0.9, method: 1, action: {\done.postln;}) + +//check how many bases we are returned: +~bases.numChannels + +//try the same process with less accuracy +FluidBufNNDSVD.process(s, b, ~bases, ~activations, coverage: 0.5, action: {\done.postln;}) +~bases.numChannels + +//use the bases to run NMF on +FluidBufNMF.process(s, b, resynth: ~resynth, bases: ~bases, activations: ~activations,actMode: 2, components: ~bases.numChannels, action: {\done.postln;}) +{PlayBuf.ar(~resynth.numChannels, ~resynth)[1]}.play +} ::