From e0d30986a2ec5b65fc29fd44e7c0b77cbd1512d2 Mon Sep 17 00:00:00 2001 From: Ted Moore Date: Wed, 3 Nov 2021 16:09:53 +0000 Subject: [PATCH] FluidWaveform helpfile made --- .../HelpSource/Classes/FluidWaveform.schelp | 43 +++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 release-packaging/HelpSource/Classes/FluidWaveform.schelp diff --git a/release-packaging/HelpSource/Classes/FluidWaveform.schelp b/release-packaging/HelpSource/Classes/FluidWaveform.schelp new file mode 100644 index 0000000..e3279cd --- /dev/null +++ b/release-packaging/HelpSource/Classes/FluidWaveform.schelp @@ -0,0 +1,43 @@ +TITLE:: FluidWaveform +summary:: Buffer waveform display with optional overlays +categories:: Libraries>FluidCorpusManipulation +related:: Classes/FluidPlotter, Classes/FluidBufNoveltySlide, Classes/FluidBufOnsetSlice, Classes/FluidBufAmpSlice + +DESCRIPTION:: +FluidWaveform plots a buffer with optional overlays such as slices derived from a FluCoMa Slicer. + +CLASSMETHODS:: + +METHOD:: new +Create a new instance of FluidWaveform. + +ARGUMENT:: audio_buf +The audio buffer to plot. + +ARGUMENT:: slices_buf +A buffer of slice indices. This will very likely be in the form of a buffer output from a FluCoMa slicer object. Currently this buffer must be only one channel, therefore it will not work with the output of link::Classes/FluidBufAmpGate::. + +ARGUMENT:: bounds +A link::Classes/Rect:: of where to place the FluidWaveform. + +returns:: A new instance of FluidWaveform. + + +INSTANCEMETHODS:: + +EXAMPLES:: + +code:: + +// load a sound to slice +~drums = Buffer.read(s,File.realpath(FluidBufAmpSlice.class.filenameSymbol).dirname.withTrailingSlash ++ "../AudioFiles/Nicol-LoopE-M.wav"); + +// create a buffer to put indices into +~indices = Buffer(s); + +// do a slice analysis +FluidBufAmpSlice.process(s,~drums,indices:~indices,fastRampUp: 10,fastRampDown: 2205,slowRampUp: 4410,slowRampDown: 4410,onThreshold: 10,offThreshold: 5,floor: -40,minSliceLength: 4410,highPassFreq: 20); + +// plot the buffer with the indices overlayed +FluidWaveform(~drums,~indices,Rect(0,0,800,200)); +::