diff --git a/CMakeLists.txt b/CMakeLists.txt index 9d28245d..74afd859 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -172,14 +172,17 @@ foreach(PACKAGE_DIRECTORY examples;extras;help;init;patchers;interfaces;javascri endforeach(PACKAGE_DIRECTORY) install(DIRECTORY "${flucoma-core_SOURCE_DIR}/Resources/AudioFiles/" - DESTINATION ${MAX_PACKAGE_ROOT}/media) + DESTINATION "${MAX_PACKAGE_ROOT}/media") install(DIRECTORY "${flucoma-core_SOURCE_DIR}/Resources/Data/" - DESTINATION ${MAX_PACKAGE_ROOT}/misc) + DESTINATION "${MAX_PACKAGE_ROOT}/misc") install(FILES icon.png package-info.json QuickStart.md DESTINATION ${MAX_PACKAGE_ROOT}) install(FILES ${flucoma-core_SOURCE_DIR}/distribution.lic DESTINATION ${MAX_PACKAGE_ROOT} RENAME LICENSE.md) +install(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/local_docs/" + DESTINATION "${MAX_PACKAGE_ROOT}/docs") + if(DOCS) install(DIRECTORY "${MAX_DOC_OUT}/" DESTINATION "${MAX_PACKAGE_ROOT}/docs" diff --git a/local_docs/fluid.buf2list.maxref.xml b/local_docs/fluid.buf2list.maxref.xml new file mode 100644 index 00000000..0d77d74b --- /dev/null +++ b/local_docs/fluid.buf2list.maxref.xml @@ -0,0 +1,153 @@ + + + + + Copy the contents of a buffer~ to a list + A simplified workflow for extracting numerical data from buffers as lists of numbers. + +

Open the Overview Patch

+ Given a source buffer that is valid, fluid.buf2list copies its contents to a new list when it receives a bang. + +This is a convenient way of extracting data from a buffer to be used elsewhere. + +

fluid.buf2list is part of the Fluid Decomposition Toolkit of the FluCoMa project. For more explanations, learning material, and discussions on its musicianly uses, visit flucoma.org.

+ + + + FluCoMa + Fluid Decomposition + corpus + + + + + + + + + + + + Maximum list size + + + Sets a maximum size for the internal list. The absolute maximum in Max is 32767. + + + + + + + + + + + + + + + + + + + + + + Trigger processing + + + Extract data from the source buffer~, given the current values of startframe, numframes, startchan and numchans. + + + + + + + + + Set the source buffer~ and trigger processing + + + Sets the value of source Then processes as if bang had been called. + + + + + + + + + + Direction in which to copy from the source. + + + In what direction to copy data from the source. 0 copies frame by frame, 1 copies channel-by-channel. + + + + + + + + + + + The buffer~ to copy the values from. + + + Sets the source buffer~ to copy data from. + + + + + + + Start channel in destination. + + + For multichannel input buffers, which channel to begin copying from. The default is 0. + + + + + + + + + + + Start frame in destination. + + + The starting index (in samples) to copy values from the source buffer~. + + + + + + + + + + + + + + + + + + + diff --git a/local_docs/fluid.list2buf.maxref.xml b/local_docs/fluid.list2buf.maxref.xml new file mode 100644 index 00000000..544a6d05 --- /dev/null +++ b/local_docs/fluid.list2buf.maxref.xml @@ -0,0 +1,144 @@ + + + + + Copy a list to a buffer~ + Copies the values of a list to a buffer~. + +

Open the Overview Patch

+ fluid.list2buf copies the values of a list to a buffer~. + +This is a convenient way of transforming data such that it can interface with other FluCoMa objects that expect to receive a buffer. + +Be aware that if a buffer of a predefined size is not supplied as the output it will defer the copying. If you need the copying to occur in the high priority thread, supply a buffer with the size of the input. + +

fluid.list2buf is part of the Fluid Decomposition Toolkit of the FluCoMa project. For more explanations, learning material, and discussions on its musicianly uses, visit flucoma.org.

+ + + + FluCoMa + Fluid Decomposition + corpus + + + + + + + + + + + + Maximum list size + + + Sets a maximum size for the internal list. The absolute maximum in Max is 32767. + + + + + + + + + + + + + + + + + + + + + + + + + + Determines if the output buffer will be resized according to the size of the input list. + + + Sets whether the destination buffer~ should be resized as needed. Note that this only applies when invoking from the main thread: buffer~s can not be resized from the high priority thread. + + + + + + + + + + + Direction in which to write to destination. + + + In what direction to write data to destination. 0 writes frame by frame, 1 writes channel-by-channel. + + + + + + + + + + + The buffer~ to copy the list values to. + + + Sets the destination buffer~ into which to write list data. If this is unset then the object will use its own automatically named buffer~. + + + + + + + Start channel in destination. + + + For multichannel output buffers, which channel to begin copying to. The default is 0. + + + + + + + + + + + Start frame in destination. + + + The starting index (in samples) to copy list to the destination buffer~. + + + + + + + + + + + + + + + + + + + diff --git a/local_docs/fluid.plotter.maxref.xml b/local_docs/fluid.plotter.maxref.xml new file mode 100644 index 00000000..419247b5 --- /dev/null +++ b/local_docs/fluid.plotter.maxref.xml @@ -0,0 +1,196 @@ + + + + + Plot data in a two-dimensional graph. + A JSUI object that plots data in a two-dimensional graph. + +

Open the Overview Patch

+ The fluid.plotter object can be used as a versatile solution for plotting points in a two-dimensional graph. + +It is designed to easily accept the contents of a fluid.dataset~ via a dictionary as coordinates within the graph as well as the contents of a fluid.labelset~ via a dictionary as colours for points. + +There is also an 'advanced' interface that allows the user to specify the coordinates and colours of the points in a more flexible and bespoke manner. See the help file for more information on this. + +

fluid.plotter is part of the Fluid Decomposition Toolkit of the FluCoMa project. For more explanations, learning material, and discussions on its musicianly uses, visit flucoma.org.

+ + + + FluCoMa + Fluid Decomposition + corpus + + + + + + A dictionary of coordinates for the points in the graph. + + + The dictionary of coordinates in the correct format for the plotter. By default, the dump method of a fluid.dataset~ will work. + + + + + A dictionary of labels for the points in the graph. + + + The dictionary of labale in the correct format for the plotter. By default, the dump method of a fluid.labelset~ will work. + + + + + + + + The position of the mouse. + + + The position of the mouse will be reported while the mouse is over the plotter and is clicking and dragging. The position is constrained to the domain of the plotter. + + + + + Zoom updates. + + + Reports any updates made to the plotter view while zooming. + + + + + + + + + + + + + + + + Set the x-axis range. + + + + + + + + + + Set the y-axis range. + + + + + + + + + + Set the x- and y-axis ranges. + + + + + + + + + Change the colour scheme for automatic colouring via a fluid.labelset~. Options are default, cat, accent, dark, paired, tableau, R4, R3, R2, R1, random. Taken mostly from d3-scale-chromatic. + + + + + + + + + + + Set the point at the given coordinates. + + + + + + + + + + + + + Set the color of the point with a given identifier. + + + + + + + + + + Set the size of the point with a given identifier. + + + + + + + + + Set the overall size of the points. + + + + + + + + + Modifies the shape of the points. + + + + + + + + Clears the graph and all associated data and settings. + + + + + + + + An alias of clear. Clears the graph. + + + + + + + + + + + + + + + + + + diff --git a/local_docs/fluid.waveform~.maxref.xml b/local_docs/fluid.waveform~.maxref.xml new file mode 100644 index 00000000..2f7f75d7 --- /dev/null +++ b/local_docs/fluid.waveform~.maxref.xml @@ -0,0 +1,117 @@ + + + + + Visualise audio waveforms and data. + A JSUI object for visualising waveforms, feature data, slices and spectrograms. + +

Open the Overview Patch

+ The fluid.waveform~ object is designed for visualising audio waveforms, feature data, slices and spectrograms. This is a convenient way to interrogate analysis, or visualise the results of processes. + +

fluid.waveform~ is part of the Fluid Decomposition Toolkit of the FluCoMa project. For more explanations, learning material, and discussions on its musicianly uses, visit flucoma.org.

+ + + + FluCoMa + Fluid Decomposition + corpus + + + + + + + + + + + + + + + + + + + + Paint a waveform from a buffer. + + + + + + + + + + Paint a feature curve from a buffer. + + + + + + + + + Construct an image from a two-dimensional buffer~ of values, such as a spectrogram. + + + + + + + + + + Paint vertical slices stored in a buffer~ onto the waveform. These markers can be moved, deleted, and added manually too. + + + + + + + + + Remove a specific layer from the waveform. + + + + + + + + Reset the state of the object. + + + + + + + + Set the background color. + + + + + + + + + + + + + + + + + +