(buf)ampsplice objects, classes, and help skeleton

release-packaging/Classes/FluidAmpSlice.sc

@@ -0,0 +1,11 @@
+FluidAmpSlice : UGen {
+	*ar { arg in = 0, absRampUp = 10, absRampDown = 10, absThreshOn = -40, absThreshOff = -40, minSliceLength = 1, minSilenceLength = 1, minLengthAbove = 1, minLengthBelow = 1, lookBack = 0, lookAhead = 0, relRampUp = 1, relRampDown = 1, relThreshOn = -144, relThreshOff = -144, highPassFreq = 250, maxSize = 88200, outputType = 0;
+		^this.multiNew('audio', in.asAudioRateInput(this), absRampUp, absRampDown, absThreshOn, absThreshOff, minSliceLength, minSilenceLength, minLengthAbove, minLengthBelow, lookBack, lookAhead, relRampUp, relRampDown, relThreshOn, relThreshOff, highPassFreq, maxSize, outputType)
+	}
+	checkInputs {
+		if(inputs.at(16).rate != 'scalar') {
+			^(": maxSize cannot be modulated.");
+			};
+		^this.checkValidInputs;
+	}
+}

release-packaging/Classes/FluidBufAmpSlice.sc

@@ -0,0 +1,21 @@
+FluidBufAmpSlice{
+		*process { arg server, source, startFrame = 0, numFrames = -1, startChan = 0, numChans = -1, indices, absRampUp = 10, absRampDown = 10, absThreshOn = -40, absThreshOff = -40, minSliceLength = 1, minSilenceLength = 1, minLengthAbove = 1, minLengthBelow = 1, lookBack = 0, lookAhead = 0, relRampUp = 1, relRampDown = 1, relThreshOn = -144, relThreshOff = -144, highPassFreq = 250, outputType = 0, action;
+
+		var maxSize = max(minLengthAbove + lookBack, max(minLengthBelow,lookAhead));
+
+		source = source.asUGenInput;
+		indices = indices.asUGenInput;
+
+		source.isNil.if {"FluidBufAmpSlice:  Invalid source buffer".throw};
+		indices.isNil.if {"FluidBufAmpSlice:  Invalid features buffer".throw};
+
+		server = server ? Server.default;
+
+		forkIfNeeded{
+			server.sendMsg(\cmd, \BufAmpSlice, source, startFrame, numFrames, startChan, numChans, indices, absRampUp, absRampDown, absThreshOn, absThreshOff, minSliceLength, minSilenceLength, minLengthAbove, minLengthBelow, lookBack, lookAhead, relRampUp, relRampDown, relThreshOn, relThreshOff, highPassFreq, maxSize, outputType);
+			server.sync;
+			indices = server.cachedBufferAt(indices); indices.updateInfo; server.sync;
+			action.value(indices);
+		};
+	}
+}

release-packaging/HelpSource/Classes/FluidAmpSlice.schelp

@@ -0,0 +1,99 @@
+TITLE:: FluidAmpSlice
+SUMMARY:: Amplitude-based Slicer
+CATEGORIES:: Libraries>FluidDecomposition
+RELATED:: Guides/FluCoMa, Guides/FluidDecomposition
+
+DESCRIPTION::
+This class implements an amplitude-based slicer, with various customisable options and conditions to detect absolute and relative amplitude changes as onsets and offsets. 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).::
+
+FluidAmpSlice is based on two envelop followers on a highpassed version of the signal: one absolute, and one relative. Each have features that will interact, including independent Schmidt triggers and state-aware time contraints. The example code below is unfolding the various possibilites in order of complexity.
+
+The process will return an audio steam with square envelopes around detected slices the different slices, where 1s means in slice and 0s mean in silence.
+
+CLASSMETHODS::
+
+METHOD:: ar
+	The audio rate version of the object.
+
+ARGUMENT:: in
+	The audio to be processed.
+
+ARGUMENT:: absRampUp
+	The number of samples the absolute envelope follower will take to reach the next value when raising.
+
+ARGUMENT:: absRampDown
+	The number of samples the absolute envelope follower will take to reach the next value when falling.
+
+ARGUMENT:: absThreshOn
+	The threshold in dB of the absolute envelope follower to trigger an onset, aka to go ON when in OFF state.
+
+ARGUMENT:: absThreshOff
+	The threshold in dB of the absolute envelope follower to trigger an offset, , aka to go ON when in OFF state.
+
+ARGUMENT:: minSliceLength
+	The length in samples that the Slice will stay ON. Changes of states during that period will be ignored.
+
+ARGUMENT:: minSilenceLength
+	The length in samples that the Slice will stay OFF. Changes of states during that period will be ignored.
+
+ARGUMENT:: minLengthAbove
+	The length in samples that the absolute envelope have to be above the threshold to consider it a valid transition to ON. The Slice will start at the first sample when the condition is met. Therefore, this affects the latency.
+
+ARGUMENT:: minLengthBelow
+	The length in samples that the absolute envelope have to be below the threshold to consider it a valid transition to OFF. The Slice will end at the first sample when the condition is met. Therefore, this affects the latency.
+
+ARGUMENT:: lookBack
+	The length of the buffer kept before an onset to allow the algorithm, once a new Slice is detected, to go back in time (up to that many samples) to find the minimum amplitude as the Slice onset point. This affects the latency of the algorithm.
+
+ARGUMENT:: lookAhead
+	The length of the buffer kept after an offset to allow the algorithm, once the Slice is considered finished, to wait further in time (up to that many samples) to find a minimum amplitude as the Slice offset point. This affects the latency of the algorithm.
+
+ARGUMENT:: relRampUp
+	The number of samples the relative envelope follower will take to reach the next value when raising. Typically, this will be faster than absRampUp.
+
+ARGUMENT:: relRampDown
+	The number of samples the relative envelope follower will take to reach the next value when falling. Typically, this will be faster than absRampDown.
+
+ARGUMENT:: relThreshOn
+	The threshold in dB of the relative envelope follower to trigger an onset, aka to go ON when in OFF state. It is computed on the difference between the two envelope followers.
+
+ARGUMENT:: relThreshOff
+	The threshold in dB of the relative envelope follower to reset, aka to allow the differential envelop to trigger again.
+
+ARGUMENT:: highPassFreq
+	The frequency of the fourth-order Linkwitz–Riley high-pass filter (https://en.wikipedia.org/wiki/Linkwitz%E2%80%93Riley_filter). This is done first on the signal to minimise low frequency intermodulation with very fast ramp lengths.
+
+ARGUMENT:: maxSize
+	How large can the buffer be for time-critical conditions, by allocating memory at instantiation time. This cannot be modulated.
+
+ARGUMENT:: outputType
+(describe argument here)
+
+RETURNS::
+	An audio stream with square envelopes around the slices. The latency between the input and the output is STRONG::max(minLengthAbove + lookBack, max(minLengthBelow,lookAhead))::.
+
+EXAMPLES::
+
+code::
+//basic tests: highPass sanity
+(
+	{var env, source = SinOsc.ar(320,0,0.5);
+		env = FluidAmpSlice.ar(source,highPassFreq:2000, outputType:1);
+		[source, env]
+	}.plot(0.03);
+)
+//basic tests: absRampUp-Down sanity
+(
+	{var env, source = SinOsc.ar(320,0,0.5);
+		env = FluidAmpSlice.ar(source,absRampUp:10, absRampDown:1000, outputType:2);
+		[source.abs, env]
+	}.plot(0.03);
+)
+//basic tests: absThresh sanity
+(
+			{var env, source = SinOsc.ar(320,0,LFTri.ar(10).abs);
+		env = FluidAmpSlice.ar(source,absRampUp:10, absRampDown:1000, outputType:0, relThreshOn:-144, relThreshOff: -200);
+		[source, env]
+	}.plot(0.05);
+)
+::

src/FluidAmpSlice/CMakeLists.txt

@@ -0,0 +1,20 @@
+cmake_minimum_required(VERSION 3.3)
+get_filename_component(PLUGIN ${CMAKE_CURRENT_LIST_DIR} NAME_WE)
+message("Configuring ${PLUGIN}")
+set(FILENAME ${PLUGIN}.cpp)
+
+add_library(
+  ${PLUGIN}
+  MODULE
+  ${FILENAME}
+)
+
+target_include_directories(
+  ${PLUGIN} PRIVATE ${CMAKE_CURRENT_LIST_DIR}/../../include
+)
+
+target_link_libraries(
+  ${PLUGIN} PRIVATE FLUID_DECOMPOSITION
+)
+
+include(${CMAKE_CURRENT_LIST_DIR}/../../scripts/target_post.cmake)

src/FluidAmpSlice/FluidAmpSlice.cpp

@@ -0,0 +1,14 @@
+
+// A tool from the FluCoMa project, funded by the European Research Council (ERC) under the European Union’s Horizon 2020 research and innovation programme (grant agreement No 725899)
+
+#include <clients/rt/AmpSlice.hpp>
+#include <FluidSCWrapper.hpp>
+
+static InterfaceTable *ft;
+
+PluginLoad(FluidSTFTUGen)
+{
+  ft = inTable;
+  using namespace fluid::client;
+  makeSCWrapper<AmpSlice>("FluidAmpSlice", ft);
+}

src/FluidBufAmpSlice/CMakeLists.txt

@@ -0,0 +1,20 @@
+cmake_minimum_required(VERSION 3.3)
+get_filename_component(PLUGIN ${CMAKE_CURRENT_LIST_DIR} NAME_WE)
+message("Configuring ${PLUGIN}")
+set(FILENAME ${PLUGIN}.cpp)
+
+add_library(
+  ${PLUGIN}
+  MODULE
+  ${FILENAME}
+)
+
+target_include_directories(
+  ${PLUGIN} PRIVATE ${CMAKE_CURRENT_LIST_DIR}/../../include
+)
+
+target_link_libraries(
+  ${PLUGIN} PRIVATE FLUID_DECOMPOSITION
+)
+
+include(${CMAKE_CURRENT_LIST_DIR}/../../scripts/target_post.cmake)

src/FluidBufAmpSlice/FluidBufAmpSlice.cpp

@@ -0,0 +1,15 @@
+
+// FD_BufHPSS, an NRT buffer HPSS Processor
+// A tool from the FluCoMa project, funded by the European Research Council (ERC) under the European Union’s Horizon 2020 research and innovation programme (grant agreement No 725899)
+
+#include <clients/rt/AmpSlice.hpp>
+#include <FluidSCWrapper.hpp>
+
+static InterfaceTable *ft;
+
+PluginLoad(OfflineFluidDecompositionUGens)
+{
+  ft = inTable;
+  using namespace fluid::client;
+  makeSCWrapper<NRTAmpSlice>("BufAmpSlice", ft);
+}