[Docs] BufCompose Help File #155
Conversation
tremblap
left a comment
tremblap
left a comment
There was a problem hiding this comment.
very clear first tab. The main page is truncating the text (we should see it in full in tab 1 and not at all in tab2+ I think)
:
tab2: destgain could be $1 and float so people can experiment without editing the patch - also we should put a clear on the destination if that becomes more playful and explorable (since it will pile up!)
tab 3: is there a way for the composite message to look less crammed? maybe a few annotated messages so it is simpler to read?
tab 4 is good - channels will be repeated , should we add starting from 0?
all other more advanced examples have disappeared. either we should point at them in the example folder (they were all very useful to showcase the flexibility of it) or added back (but I understand the desire of streamlining)
flucoma/flucoma-docs#95 will make it shorter and fit into the space I've given it.
good idea
done
Not sure I understand.
They will find a new home in the FluCoMa tutorial system and be linked in a new tab. |
if one has a stereo input, ask for numChans 2 and startchan 1, one will get the stereo inversed. this was one of the advanced examples that have been removed - they were quite involved so the help might not be the best place for them, but we need to explain that channels are not 'copied' but start back to 0 (round robin? modulo?)
I saw the new issue. indeed a sort of vignette for advanced bufcomposing is probably the best way forward to declutter the help file and not get a [groove~] one |
Okay yep but the source that has |
|
I know, but this sentence is misleading of the underlying behaviour. let's find an alternative elegant way of saying what it does |
? |
|
that will need @weefuzzy wordmagic here I think :) |
* optional args: add to wrapper * MaxWrapper: Add choices param (list of symbols <-> bitset) * changing preset and interface for noveltyslice examples * correct typos and misconnections in helpfiles (onsetslice and bufselectevery) * Buf2List(2Buf): Correct atom type Fixes MSVC debug builds * kdtreehelp: now loads programatically, in order, from the stored labelset (#184) * now loads programatically, in order, from the stored labelset * corrected a view * also, fluid.umap helpfile now uses the loader * fix #185 `ControlIn` objects – properly adjust `ac` when adjusting `av` – ensure mListSize is always intialized to something – fix resize logic * Enhance/max params (#182) * CMake: Centralise C++ version and set to 17 * Wrapper: Handle new LongRuntimeMax parameter type * POC for better buffer object chaining (#140) * start of POC for buffer management stuff, needs fix to ParamDesc NumOf in core * working POC for managing internal output buffers and process chaining relies on some pending updates to core * Don't override box arguments with default buffers * NRT: One outlet per output buffer, no progress outlet, draw progress on box * Messages: Default instances for output container args * updates to message default instances that don't break all other objects * Add optional range arguments to buffer message in left inlet * Stop MSVC being sad * Wrapper: fix merge casuality * [Fix] Broken patches due to new dataset/buffer interface interface (#195) * update dataset * fix broken cabling in datasetquery * update kmeans * make more max-like in style * "maxify" the style * fix connections and maxify style of labelset~ * fix connections in umap and maxify * fix connections and mafixy fluid.grid~ * update kdtree~ help with fixed cables and max style * fix connections and maxify style of normalize * cosmetic upgrades * update fluid.plotter cables * fix bufstats due to tb * [Fix] Missing OnsetSlice Files (#197) * restore to previous state * fix some style errors * fix style issues * Wrapper: Update for new `maxFFTSize` * [Docs] BufCompose Help File (#155) * griddify patch tab s * update first tab * second tab * macros * subsections tab * small cosmetic changes * update final tabs of help file * make tab 2 playable * clean tab 3 * cosmetic * PAs addendums * Wrapper: Fix reset for shared objects. fixes #43 Will 'reset' to whatever was in the box that the message was called on, so potential for confusion... * Wrapper: Fix managed object aliasing in message invocations. fixes #190 * List2Buf: Correct outlet type. fixes #196 * [Docs] BufSpectralShape Help File (#156) * grid it out * bufspectralshape help file * add a layout of results tab * add @select tab and final changes * translate SC -> Max (#187) * Wrapper: call params::set() properly for long array attrs To ensure that client objects like attrui update properly in shared instances * touch up ampslice example with Rod's audio * prepare help file * shell out the tabs * ampslice updates * Wrapper: Use raw value for maxFFT when refreshing attribute * [Help] Pitch and BufPitch SC Translations (#200) * layout * cleanup and translate * update bufpitch to match sc * fix various errors in help files (#204) * [Docs] NoveltySlice Help Files (#146) * update noveltyslice * shell out bufnovelty * small cosmetic updates * small layout issues * update bufnoveltyslice to be similar to RT algo * cosmetic * tune parameters for second tab * add a progression for tweaking parameters * [Fix] Saner maximum sizes for modulatable examples (#205) * add bigger maximums for noveltyslice for modulation fun * set a bigger maximum kernelsize for realtime playing * maximum parameter tweaks * [Fix] Various Bug Fixes From PA (#210) * fix bufcompose * fix bufampslice playback * change from groove to play * corrected players of 2nd tabs fixing #202 * Wrapper: Trying once again to get maxParams logic correct * neaten and provide an example (#216) perfect thanks! * [Docs] HPSS and BufHPSS translation (#219) * prepare help files with grid/fonts * cleanup help file layout * cleanup help files * update remaining tabs for hpss * [Docs] MFCC and BufMFCC Translation (#217) * update rt mfcc * update bufmfcc to match translation better * PAs review * [Docs] MelBands + BufMelBands Translation (#214) * translate rt version * add ioscbank and size $1 * translate bufmelbands * fix loadbang mistake * [Docs] BufFlatten Translation (#218) * update bufflatten * normalise fonts and grid size * cosmetic movements * change language around buffer management * [Docs] Update fluid.list2buf (#188) * update list2buf help file * change language in resize tab * resize destination buffers downwards * list2buf - list typo * bufmelbands - corrected loadbang issue * bufmfcc - typo * Enhance/generate stubs (#231) * CMake: Generate .cpp files * CMake: Ensure MSVC compiles commonsyms.c Enable C as a language for project... * Remove all old handwritten CMake and stubs * CMake: Tidy up Max SDK setup * CMake: ensure correct MSVC runtime by default * CMake: Correct hints for Max SDK libs * CMake: Asking once again to compile happily on two platforms * CMake: install prefix is a cache variable * CMake: Move install prefix override * CMake reinstate target for triggering docs in ALL * CMake: Tidy up * CMake: typo * Wrapper: FFT max set properly after initialization * CI: Update nightly workflow * CI: use correct branches * CI: remove reference to docs job * CMake: belatedly add branch selection for flucoma deps upon which CI relies * Reinstate package-json generation * [Docs] NMFFilter Translation (#222) * translate nmffilter * make ezdac local * [Docs] BufStats translation (#220) * prepare bufstats help file * in progress * full translation * add a derivative tab * cosmetics * remove debug print * [Docs] NMFMatch Translation (#221) * prepare and grid * work on compressor example * work in compressor parameters * finish translation * alter compressor example to be less idiosyncratic with vector sizes * [Docs] MLPClassifier Translation (#226) * wip * mlpclassifier translation * add caveat about predicting whole dataset * layout * [Docs] BufNMF Translation (#229) * grid and format * WIP * translation of nmf sc * remove nooiseplay vocoder * cleanup small errors * make channel offset permanent * vocoder pfft patch * add back vocoder example with tweaks * mds translation (#235) * [Docs] RobustScaler SC Translation (#234) * translate standardisation * grid out * translation * add scaler visualisation back * scaler comparison re-usable tab * update with visualisation and comparison together * [Docs] Standardise SC Translation (#233) * translate standardisation * grid out * translation * add scaler visualisation back * scaler comparison re-usable tab * update with visualisation and comparison together * commit patch * update title * add scaler comparison * [Docs] MLPRegressor Translation (#228) * prepare help file * shell out tabs * mlpregressor translation * [Fix] Plotter internal state management (#242) * refactor code to be handle state in a more legible manner * only output position on mousedown (not mouseup) * instantiate fluid.plotter with no border * dont reset domain/range state with clear * fix help file * CMake: Pick up new Client tag to control tildes in external names better * updated nmf examples with new interface * change @SiZe to @history (#243) * [Enhance] Manual Documentation for CCE Objects (#250) * install the contents of manual_docs to release-packaging docs * add manual docs * rename manual_docs to local_docs * update CMake to respect new path name * use more robust path for local docs * add default arguments and buffer messages * en-quote * add max list size as argument * provide use case for spectrogram * caveat about manual interaction with slices * update descriptions and digest * return destination -> source * [Fix] Various patcher bugs (#253) * fix bufselect~ * blank out bufstats values in messages * fix feature patches with new interface * cosmetic fix on kmeans * add feature objects to landing page * [Docs] Stats SC Translation (#245) * grid it out * update first tab * mimic Ted's real use case tab * normalize hehe the normalize help file with other scalers (#246) * [Docs] PCA SC Translation (#247) * add whitening tab * add stackexchange link * [Docs] BufNNDSVD SC Translation (#251) * update nndsvd help file to match sc * fix numchans error * translation (#255) * [Docs] STFT SC Translation (#248) * prepare help file * rework first tab * in progress * cleanup first tab * musical stft example * mild cleanup * finish musical example * change sound file examples * translate knnregressor (#256) * [Docs] NMFMorph SC Translation (#258) * start editing * wip * translate nmfmorph * [Docs] BufNMFCross SC Translation (#254) * prepare help file * translation * delete superfluous tab * typo in bufnmf help * [Fix] Various load issues (#261) * fix maxsize argument for bufaudiotransport * fix broken patch cables in bufchroma * fix loading error * fix broken dataset cables * fix maxsize * maxsize * cosmetic * broken cables * stats maxsize * typo * cosmetic * small cosmeti fixes * cosmetic touch ups * always load even if loadbang is disabled * non local ezdac (#262) * change of interface (#260) * typo * skmeans translation from SC (missing one tab also missing in kmeans) (#264) * [CI] Update Release Workflow (#266) * cleanup nightly release * normalise naming extensions * update release * Revert "normalise naming extensions" This reverts commit 2398518. * update extension * remove workflow dispatch variables * [Docs] Transients Family Translation (#259) * translate transientslice * translate buftransientslice * fluid.transients~ translation * cosmetic * translate buftransients * make mc example dual mono * add zoom on content * [Docs] AmpGate SC Translation (#241) * grid help file * translate ampgate * cosmetic * silence removal example * neaten patch * finish off lookahead/lookback prettification * fix onset/offset conceptual break * defer loading of tab 3 * cosmetic * MaxWrapper: Ensure box is properly released from `progress` upon cancel * [Docs] (S)Kmeans Distances Tab (#267) * add distance tab * add argument for choosing default dataaset * add distances tab * add distances tab * cleanup * beta testing patches updated for beta7 (#268) * typo * typo * typo * fix release worflow * fix bad path * fix branch
2 participants
Updates the bufcompose help file. Not much changed apart from aesthetics and consistency.