added the related header too

6 years ago · 908a56e048
parent 9de3853742
commit 908a56e048
17 changed files with 38 additions and 16 deletions
--- a/release-packaging/HelpSource/Classes/FluidBufAmpSlice.schelp
+++ b/release-packaging/HelpSource/Classes/FluidBufAmpSlice.schelp
@ -1,7 +1,7 @@
 TITLE:: FluidBufAmpSlice
 SUMMARY:: Amplitude-based Slicer for Buffers
 CATEGORIES:: Libraries>FluidDecomposition
-RELATED:: Guides/FluCoMa, Guides/FluidDecomposition
+RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Guides/FluidBufMultiThreading

 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).::
--- a/release-packaging/HelpSource/Classes/FluidBufCompose.schelp
+++ b/release-packaging/HelpSource/Classes/FluidBufCompose.schelp
@ -1,7 +1,7 @@
 TITLE:: FluidBufCompose
 SUMMARY:: Buffer Compositing Utility
 CATEGORIES:: Libraries>FluidDecomposition, UGens>Buffer
-RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Classes/Buffer
+RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Guides/FluidBufMultiThreading, Classes/Buffer

 DESCRIPTION::
 A FluidBufCompose object provides a flexible utility for combining the contents of buffers on the server. It can be used for thing like mixing down multichannel buffers, or converting from left-right stereo to mid-side. It is used extensively in all the example code of LINK::Guides/FluidDecomposition:: as part of the FluCoMa project. footnote::
--- a/release-packaging/HelpSource/Classes/FluidBufHPSS.schelp
+++ b/release-packaging/HelpSource/Classes/FluidBufHPSS.schelp
@ -1,7 +1,7 @@
 TITLE:: FluidBufHPSS
 SUMMARY:: Buffer-Based Harmonic-Percussive Source Separation Using Median Filtering
 CATEGORIES:: Libraries>FluidDecomposition, UGens>Buffer
-RELATED:: Guides/FluCoMa, Guides/FluidDecomposition
+RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Guides/FluidBufMultiThreading


 DESCRIPTION::
--- a/release-packaging/HelpSource/Classes/FluidBufLoudness.schelp
+++ b/release-packaging/HelpSource/Classes/FluidBufLoudness.schelp
@ -1,7 +1,7 @@
 TITLE:: FluidBufLoudness
 SUMMARY:: A Loudness and True-Peak Descriptor on a Buffer
 CATEGORIES:: Libraries>FluidDecomposition
-RELATED:: Guides/FluCoMa, Guides/FluidDecomposition
+RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Guides/FluidBufMultiThreading


 DESCRIPTION::
--- a/release-packaging/HelpSource/Classes/FluidBufMFCC.schelp
+++ b/release-packaging/HelpSource/Classes/FluidBufMFCC.schelp
@ -1,7 +1,7 @@
 TITLE:: FluidBufMFCC
 SUMMARY:: Mel-Frequency Cepstral Coefficients as Spectral Descriptors on a Buffer
 CATEGORIES:: Libraries>FluidDecomposition
-RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Classes/FluidBufMelBands
+RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Guides/FluidBufMultiThreading, Classes/FluidBufMelBands

 DESCRIPTION::
 This class implements a classic spectral descriptor, the Mel-Frequency Cepstral Coefficients (https://en.wikipedia.org/wiki/Mel-frequency_cepstrum). The input is first filtered in to STRONG::numBands:: perceptually-spaced bands, as in LINK::Classes/FluidMelBands::. It is then analysed into STRONG::numCoeffs:: number of cepstral coefficients. It has the avantage of being amplitude invarient, except for the first coefficient. 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).::
--- a/release-packaging/HelpSource/Classes/FluidBufMelBands.schelp
+++ b/release-packaging/HelpSource/Classes/FluidBufMelBands.schelp
@ -1,7 +1,7 @@
 TITLE:: FluidBufMelBands
 SUMMARY:: A Perceptually Spread Spectral Contour Descriptor on a Buffer
 CATEGORIES:: Libraries>FluidDecomposition
-RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Classes/FluidBufMFCC
+RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Guides/FluidBufMultiThreading, Classes/FluidBufMFCC


 DESCRIPTION::
--- a/release-packaging/HelpSource/Classes/FluidBufNMF.schelp
+++ b/release-packaging/HelpSource/Classes/FluidBufNMF.schelp
@ -1,7 +1,7 @@
 TITLE:: FluidBufNMF
 SUMMARY:: Buffer-Based Non-Negative Matrix Factorisation on Spectral Frames
 CATEGORIES:: Libraries>FluidDecomposition, UGens>Buffer
-RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Classes/FluidNMFMatch, Classes/FluidNMFFilter
+RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Guides/FluidBufMultiThreading, Classes/FluidNMFMatch, Classes/FluidNMFFilter

 DESCRIPTION::
 The FluidBufNMF object decomposes the spectrum of a sound into a number of components using Non-Negative Matrix Factorisation (NMF) footnote:: Lee, Daniel D., and H. Sebastian Seung. 1999. ‘Learning the Parts of Objects by Non-Negative Matrix Factorization’. Nature 401 (6755): 788–91. https://doi.org/10.1038/44565.
--- a/release-packaging/HelpSource/Classes/FluidBufNoveltySlice.schelp
+++ b/release-packaging/HelpSource/Classes/FluidBufNoveltySlice.schelp
@ -1,7 +1,7 @@
 TITLE:: FluidBufNoveltySlice
 SUMMARY:: Buffer-Based Novelty-Based Slicer
 CATEGORIES:: Libraries>FluidDecomposition, UGens>Buffer
-RELATED:: Guides/FluCoMa, Guides/FluidDecomposition
+RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Guides/FluidBufMultiThreading

 DESCRIPTION::
 This class implements a non-real-time slicer using an algorithm assessing novelty in the signal to estimate the slicing points. A novelty curve is being derived from running a kernel across the diagonal of the similarity matrix, and looking for peak of changes. It implements the seminal results published in  'Automatic Audio Segmentation Using a Measure of Audio Novelty' by J Foote.  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).::
--- a/release-packaging/HelpSource/Classes/FluidBufOnsetSlice.schelp
+++ b/release-packaging/HelpSource/Classes/FluidBufOnsetSlice.schelp
@ -1,7 +1,7 @@
 TITLE:: FluidBufOnsetSlice
 SUMMARY:: Spectral Difference-Based Audio Buffer Slicer
 CATEGORIES:: Libraries>FluidDecomposition
-RELATED:: Guides/FluCoMa, Guides/FluidDecomposition
+RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Guides/FluidBufMultiThreading

 DESCRIPTION::
 This class implements many spectral-based onset detection metrics, most of them taken from the literature. (http://www.dafx.ca/proceedings/papers/p_133.pdf) Some are already available in SuperCollider's LINK::Classes/Onsets:: object yet not as offline processes. 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).::
--- a/release-packaging/HelpSource/Classes/FluidBufPitch.schelp
+++ b/release-packaging/HelpSource/Classes/FluidBufPitch.schelp
@ -1,7 +1,7 @@
 TITLE:: FluidBufPitch
 SUMMARY:: A Selection of Pitch Descriptors on a Buffer
 CATEGORIES:: Libraries>FluidDecomposition
-RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Classes/SpecCentroid, Classes/SpecFlatness, Classes/SpecCentroid, Classes/SpecPcile
+RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Guides/FluidBufMultiThreading, Classes/SpecCentroid, Classes/SpecFlatness, Classes/SpecCentroid, Classes/SpecPcile


 DESCRIPTION::
--- a/release-packaging/HelpSource/Classes/FluidBufSines.schelp
+++ b/release-packaging/HelpSource/Classes/FluidBufSines.schelp
@ -1,7 +1,7 @@
 TITLE:: FluidBufSines
 SUMMARY:: Buffer-Based Sinusoidal Modelling and Resynthesis
 CATEGORIES:: Libraries>FluidDecomposition, UGens>Buffer
-RELATED:: Guides/FluCoMa, Guides/FluidDecomposition
+RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Guides/FluidBufMultiThreading, Guides/FluidBufMultiThreading


 DESCRIPTION::
--- a/release-packaging/HelpSource/Classes/FluidBufSpectralShape.schelp
+++ b/release-packaging/HelpSource/Classes/FluidBufSpectralShape.schelp
@ -1,7 +1,7 @@
 TITLE:: FluidBufSpectralShape
 SUMMARY:: Seven Spectral Shape Descriptors on a Buffer
 CATEGORIES:: Libraries>FluidDecomposition
-RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Classes/SpecCentroid, Classes/SpecFlatness, Classes/SpecCentroid, Classes/SpecPcile
+RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Guides/FluidBufMultiThreading, Classes/SpecCentroid, Classes/SpecFlatness, Classes/SpecCentroid, Classes/SpecPcile


 DESCRIPTION::
--- a/release-packaging/HelpSource/Classes/FluidBufStats.schelp
+++ b/release-packaging/HelpSource/Classes/FluidBufStats.schelp
@ -1,7 +1,7 @@
 TITLE:: FluidBufStats
 SUMMARY:: Computing Statistics on Buffers as Series.
 CATEGORIES:: Libraries>FluidDecomposition, UGens>Buffer
-RELATED:: Guides/FluCoMa, Guides/FluidDecomposition
+RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Guides/FluidBufMultiThreading


 DESCRIPTION::
--- a/release-packaging/HelpSource/Classes/FluidBufThreadDemo.schelp
+++ b/release-packaging/HelpSource/Classes/FluidBufThreadDemo.schelp
@ -62,4 +62,4 @@ c.cancel

 // if a simple call to the UGen is used, the progress can be monitored
 {c = FluidBufThreadDemo.kr(b,10000, Done.freeSelf); Poll.kr(Impulse.kr(2),c);}.scope;
-::
+::
--- a/release-packaging/HelpSource/Classes/FluidBufTransientSlice.schelp
+++ b/release-packaging/HelpSource/Classes/FluidBufTransientSlice.schelp
@ -1,7 +1,7 @@
 TITLE:: FluidBufTransientSlice
 SUMMARY:: Buffer-Based Transient-Based Slicer
 CATEGORIES:: Libraries>FluidDecomposition, UGens>Buffer
-RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Classes/FluidBufTransients
+RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Guides/FluidBufMultiThreading, Classes/FluidBufTransients

 DESCRIPTION::
 This class implements a non-real-time transient-based slice extractor relying on the same algorithm than Classes/FluidBufTransients using clicks/transients/derivation/anomaly in the signal to estimate the slicing points. 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).::
--- a/release-packaging/HelpSource/Classes/FluidBufTransients.schelp
+++ b/release-packaging/HelpSource/Classes/FluidBufTransients.schelp
@ -1,7 +1,7 @@
 TITLE:: FluidBufTransients
 SUMMARY:: Buffer-Based Transient Extractor
 CATEGORIES:: Libraries>FluidDecomposition, UGens>Buffer
-RELATED:: Guides/FluCoMa, Guides/FluidDecomposition
+RELATED:: Guides/FluCoMa, Guides/FluidDecomposition, Guides/FluidBufMultiThreading

 DESCRIPTION::
 This class triggers a transient extractor on buffers on the non-real-time thread of the server. It implements declicking algorithm from chapter 5 of the classic Digital Audio Restoration by Godsill, Simon J., Rayner, Peter J.W. with some bespoke improvements on the detection function tracking. It is part of the Fluid Decomposition Toolkit of the FluCoMa project. footnote::
--- a/release-packaging/HelpSource/Classes/QuickStart.md
+++ b/release-packaging/HelpSource/Classes/QuickStart.md
@ -0,0 +1,22 @@
+# Instructions for the PureData version of the fluid.* toolbox
+
+## How to start:
+
+1) move the following items to their respective relevant pd search path
+- externals are in /pd_objects
+- help files are in /help
+- audio used in the help files are in /media, which is expected to be parallel to /help
+- detailed help is provided as a website in /docs
+
+2) The PureData document 'Fluid_Decomposition_Overview.pd' shows the toolbox at a glance.
+
+5) Parameters can be set by message (as in max with the same names) OR by option in the object box which work similarly to the [sigmund~] options.
+
+6) Most objects working on arrays/buffers are multichannel. The toolbox uses the following convention: a named array is expected to have a name, followed by -x where x is the 'channel' number, 0-indexed. For instance, a stereo source buffer defined as 'mybuf' will expect an array named 'mybuf-0' for the left channel, and an array named 'mybuf-1' for the right channel. A utility [multiarray.pd] is used throughout the helpfiles in conjonction with the [clone] to programmatically generate such 'multichannel' buffers.
+
+#### Enjoy!
+
+
+## Known issues:
+- pd is single threaded so doing buffer ops will do bad things to realtime audio.
+- providing 'multichannel' arrays not enough in numbers (aka channels) will crash Pd.