From de71b7cf3c54dd7c75a692ab207efa7e14439ec5 Mon Sep 17 00:00:00 2001 From: Timothy Schoen Date: Thu, 9 Nov 2023 19:44:54 +0100 Subject: [PATCH] Updated ELSE .md files with latest changes and new objects --- Resources/Documentation/ELSE/adsr~.md | 12 ++-- Resources/Documentation/ELSE/bend.in.md | 8 +++ Resources/Documentation/ELSE/bpbank~.md | 5 +- Resources/Documentation/ELSE/circle.md | 8 +-- Resources/Documentation/ELSE/conv~.md | 8 ++- Resources/Documentation/ELSE/crusher~.md | 4 +- Resources/Documentation/ELSE/dispatch.md | 25 ++++++++ Resources/Documentation/ELSE/display.md | 4 ++ Resources/Documentation/ELSE/envgen~.md | 3 + Resources/Documentation/ELSE/fbsine~.md | 2 +- Resources/Documentation/ELSE/fm~.md | 37 +++++++++++ Resources/Documentation/ELSE/function.md | 10 +-- Resources/Documentation/ELSE/gain2~.md | 19 +++--- Resources/Documentation/ELSE/gain~.md | 19 +++--- Resources/Documentation/ELSE/imp.mc~.md | 47 -------------- Resources/Documentation/ELSE/keymap.md | 8 +++ Resources/Documentation/ELSE/knob.md | 10 +-- Resources/Documentation/ELSE/list.seq.md | 35 +++++++++++ Resources/Documentation/ELSE/loadbanger.md | 2 + Resources/Documentation/ELSE/makenote2.md | 3 + Resources/Documentation/ELSE/maxpeak~.md | 4 ++ Resources/Documentation/ELSE/mono~.md | 61 +++++++++++++++++++ Resources/Documentation/ELSE/mov.rms~.md | 7 ++- Resources/Documentation/ELSE/multi.vsl.md | 8 +-- Resources/Documentation/ELSE/nop~.md | 24 ++++++++ Resources/Documentation/ELSE/note.in.md | 26 ++++---- Resources/Documentation/ELSE/note.out.md | 11 ++-- Resources/Documentation/ELSE/numbox~.md | 8 ++- Resources/Documentation/ELSE/order.md | 2 +- Resources/Documentation/ELSE/osc.mc~.md | 44 ------------- Resources/Documentation/ELSE/oscbank2~.md | 13 ++-- Resources/Documentation/ELSE/oscbank~.md | 13 ++-- Resources/Documentation/ELSE/out1~.md | 48 --------------- Resources/Documentation/ELSE/peak~.md | 11 ++-- Resources/Documentation/ELSE/pgm.in.md | 9 +++ Resources/Documentation/ELSE/plaits~.md | 11 ++-- Resources/Documentation/ELSE/pluck~.md | 19 +++--- Resources/Documentation/ELSE/pmosc~.md | 45 -------------- Resources/Documentation/ELSE/ptouch.in.md | 9 +++ Resources/Documentation/ELSE/rampnoise.mc~.md | 41 ------------- Resources/Documentation/ELSE/rdelay~.md | 35 ----------- Resources/Documentation/ELSE/receiver.md | 5 +- Resources/Documentation/ELSE/resonbank2~.md | 15 ++--- Resources/Documentation/ELSE/resonbank~.md | 14 ++--- Resources/Documentation/ELSE/rms~.md | 17 ++++-- Resources/Documentation/ELSE/send2~.md | 23 +++++++ Resources/Documentation/ELSE/sfz~.md | 2 +- Resources/Documentation/ELSE/slider2d.md | 8 +-- Resources/Documentation/ELSE/stepnoise.mc~.md | 41 ------------- Resources/Documentation/ELSE/touch.in.md | 13 ++-- Resources/Documentation/ELSE/touch.out.md | 4 -- Resources/Documentation/ELSE/var.md | 28 +++++++++ Resources/Documentation/ELSE/voices.md | 9 +-- Source/Components/SuggestionComponent.h | 3 +- 54 files changed, 456 insertions(+), 444 deletions(-) create mode 100644 Resources/Documentation/ELSE/dispatch.md create mode 100644 Resources/Documentation/ELSE/fm~.md delete mode 100644 Resources/Documentation/ELSE/imp.mc~.md create mode 100644 Resources/Documentation/ELSE/list.seq.md create mode 100644 Resources/Documentation/ELSE/mono~.md create mode 100644 Resources/Documentation/ELSE/nop~.md delete mode 100644 Resources/Documentation/ELSE/osc.mc~.md delete mode 100644 Resources/Documentation/ELSE/out1~.md delete mode 100644 Resources/Documentation/ELSE/pmosc~.md delete mode 100644 Resources/Documentation/ELSE/rampnoise.mc~.md delete mode 100644 Resources/Documentation/ELSE/rdelay~.md create mode 100644 Resources/Documentation/ELSE/send2~.md delete mode 100644 Resources/Documentation/ELSE/stepnoise.mc~.md create mode 100644 Resources/Documentation/ELSE/var.md diff --git a/Resources/Documentation/ELSE/adsr~.md b/Resources/Documentation/ELSE/adsr~.md index 5f0835fd5..033381e57 100644 --- a/Resources/Documentation/ELSE/adsr~.md +++ b/Resources/Documentation/ELSE/adsr~.md @@ -36,15 +36,18 @@ inlets: - type: bang description: trigger/retrigger 2nd: + - type: signal + description: signal retrigger via impulses and gates + 3rd: - type: float/signal description: attack time in ms - 3rd: + 4th: - type: float/signal description: decay time in ms - 4th: + 5th: - type: float/signal description: sustain amplitude (ratio to gate value) - 5th: + 6th: - type: float/signal description: release time in ms @@ -59,7 +62,8 @@ outlets: methods: - type: lin description: non-0 sets to "lin" mode, "log" otherwise - + - type: gate + description: control gate values draft: false --- diff --git a/Resources/Documentation/ELSE/bend.in.md b/Resources/Documentation/ELSE/bend.in.md index a78efde65..3e7086f9c 100644 --- a/Resources/Documentation/ELSE/bend.in.md +++ b/Resources/Documentation/ELSE/bend.in.md @@ -13,9 +13,16 @@ arguments: description: sets channel number default: 0 - OMNI +methods: +- type: -ext + description: non zero sets to listen only to external input source + flags: - name: -raw description: sets to raw output mode (0-16383) +- name: -ext + description: only listen to external input source + default: no inlets: 1st: @@ -33,6 +40,7 @@ outlets: - type: float description: MIDI channel + draft: false --- diff --git a/Resources/Documentation/ELSE/bpbank~.md b/Resources/Documentation/ELSE/bpbank~.md index 4fdd8e90b..594cc1546 100644 --- a/Resources/Documentation/ELSE/bpbank~.md +++ b/Resources/Documentation/ELSE/bpbank~.md @@ -49,7 +49,10 @@ methods: description: list of ramp time for all filters in the bank - type: rampal description: ramp time for all filters in the bank - + - name: -mc + description: sets to multichannel output + default: 0 + draft: false --- diff --git a/Resources/Documentation/ELSE/circle.md b/Resources/Documentation/ELSE/circle.md index 494b3bb91..3b23baf09 100644 --- a/Resources/Documentation/ELSE/circle.md +++ b/Resources/Documentation/ELSE/circle.md @@ -45,8 +45,8 @@ methods: description: sets both background colors in RGB - type: fgcolor description: sets foreground color in RGB - - type: init - description: non-0 sets to init mode + - type: savestate + description: non-0 will save object state - type: clip description: non-0 clips inside the circle @@ -63,8 +63,8 @@ flags: - name: -grid description: non-0 sets grid visibility default: 0 - - name: -init - description: non-0 sets to init mode + - name: -savestate + description: non-0 sets will save object state default: 0 - name: -range description: sets range (minimum and maximum values of x and y) diff --git a/Resources/Documentation/ELSE/conv~.md b/Resources/Documentation/ELSE/conv~.md index b1b01ea75..850287cd0 100644 --- a/Resources/Documentation/ELSE/conv~.md +++ b/Resources/Documentation/ELSE/conv~.md @@ -12,7 +12,7 @@ arguments: - description: optional - partition size type: float default: 1024, minimum 64 -- description: file name to open as impulse response +- description: impulse response table name type: symbol default: none @@ -29,8 +29,10 @@ outlets: methods: - type: size description: sets partition size - - type: load - description: loads IR sound file + - type: set + description: load IR table + - type: print + description: print convolution info to console draft: false --- diff --git a/Resources/Documentation/ELSE/crusher~.md b/Resources/Documentation/ELSE/crusher~.md index baec1ffc8..6be4083b1 100644 --- a/Resources/Documentation/ELSE/crusher~.md +++ b/Resources/Documentation/ELSE/crusher~.md @@ -19,10 +19,10 @@ inlets: - type: signal description: signal to be crushed (resampled and quantized) 2nd: - - type: float/signal + - type: float description: bit reduction from 0-1 3rd: - - type: float/signal + - type: float description: decimation (sample rate reduction) from 0-1 outlets: diff --git a/Resources/Documentation/ELSE/dispatch.md b/Resources/Documentation/ELSE/dispatch.md new file mode 100644 index 000000000..7f78f5b14 --- /dev/null +++ b/Resources/Documentation/ELSE/dispatch.md @@ -0,0 +1,25 @@ +--- +title: dispatch + +description: dispatch elements of a list to different locations + +categories: + - object +pdcategory: ELSE, UI + +arguments: +- type: list + description: receive addresses + default: none + +inlets: + 1st: + - description: list to dispatch its elements + type: list + - description: dispacthes last input again. + type: bang + +draft: false +--- + +[dispatch] gets a list and sends each element to a given address (order is left to right). diff --git a/Resources/Documentation/ELSE/display.md b/Resources/Documentation/ELSE/display.md index 229e2fff1..6545bd646 100644 --- a/Resources/Documentation/ELSE/display.md +++ b/Resources/Documentation/ELSE/display.md @@ -26,6 +26,10 @@ outlets: - type: anything description: any input is passed through +flags: + - name: -noflash + description: prevents flashing when getting data. + draft: false --- diff --git a/Resources/Documentation/ELSE/envgen~.md b/Resources/Documentation/ELSE/envgen~.md index c076f5d64..ebaa5cf94 100644 --- a/Resources/Documentation/ELSE/envgen~.md +++ b/Resources/Documentation/ELSE/envgen~.md @@ -22,6 +22,9 @@ inlets: - type: list description: sets and runs envelope (pairs of duration & target. if odd, 1st float is starting point) 2nd: + - type: signal + description: impulses to retrigger the envelope + 3rd: - type: list description: sets the envelope and doesn't run it diff --git a/Resources/Documentation/ELSE/fbsine~.md b/Resources/Documentation/ELSE/fbsine~.md index 8e0ef13db..1421c801a 100644 --- a/Resources/Documentation/ELSE/fbsine~.md +++ b/Resources/Documentation/ELSE/fbsine~.md @@ -19,7 +19,7 @@ arguments: default: 0 - type: float description: mean filter: on <1> or off <0> - default: 0 + default: 1 inlets: 1st: diff --git a/Resources/Documentation/ELSE/fm~.md b/Resources/Documentation/ELSE/fm~.md new file mode 100644 index 000000000..c751f2faa --- /dev/null +++ b/Resources/Documentation/ELSE/fm~.md @@ -0,0 +1,37 @@ +--- +title: fm~ + +description: frequency modulation unit + +categories: + - object + +pdcategory: ELSE, Signal Generators + +arguments: +- type: float + description: carrier frequency in hz + default: 0 +- type: float + description: modulation frequency as ratio of carrier + default: 1 +- type: float + description: modulation index + default: 0 + +inlets: + 1st: + - type: float/signal + description: carrier frequency in hz + 2nd: + - type: float/signal + description: modulation frequency as ratio of carrier + 3rd: + - type: float/signal + description: modulation index + +draft: false + +--- + +[fm~] is a simple frequency modulation unit consisting of a pair of sinusoidal oscillators, where one modulates the frequency input of another. The modulation frequency is set as a ratio of the carrier and the modulation index is multiplied by this resulting frequency. The object has support for multichannels. \ No newline at end of file diff --git a/Resources/Documentation/ELSE/function.md b/Resources/Documentation/ELSE/function.md index 508b32032..c5a7b0b88 100644 --- a/Resources/Documentation/ELSE/function.md +++ b/Resources/Documentation/ELSE/function.md @@ -42,8 +42,9 @@ flags: description: default 0 - name: -max description: default 1 - - name: -init - description: + - name: -savestate + description: save object state + default: 0 - name: -set description: default 0 1000 0 @@ -72,8 +73,9 @@ methods: description: sets send symbol - type: receive description: sets receive symbol - - type: init - description: non-0 sets to init mode + - type: savestate + description: non-0 will save object state + draft: false --- diff --git a/Resources/Documentation/ELSE/gain2~.md b/Resources/Documentation/ELSE/gain2~.md index 4b49f18fa..1a3ad6984 100644 --- a/Resources/Documentation/ELSE/gain2~.md +++ b/Resources/Documentation/ELSE/gain2~.md @@ -36,27 +36,30 @@ flags: description: sets max gain (needs to be > 0) default: 1 - name: -mode - description: sets scaling mode: 0 (quartic), 1 (dB) or 2 (linear) + description: sets scaling mode; 0 (quartic), 1 (dB) or 2 (linear) default: quartic - name: -ramp description: sets ramp time (minimum 5) default: 20 - - name: -init - description: sets to init mode - default: no init + - name: -savestate + description: save object state + default: 0 methods: - type: set description: sets slider (range is clipped to 0-1) - type: mode - description: scaling mode: 0 (quartic, default), 1 (dB) or 2 (linear) + description: scaling mode; 0 (quartic, default), 1 (dB) or 2 (linear) - type: gain description: sets max gain (values <= 0 are ignored) - type: ramp description: sets ramp time in ms for slider values (default 20) - - type: init - description: non-0 sets to init mode - + - type: savestate + description: non-0 will save object state + - type: learn + description: learns a MIDI controller + - type: forget + description: forgets a MIDI controller draft: false --- diff --git a/Resources/Documentation/ELSE/gain~.md b/Resources/Documentation/ELSE/gain~.md index 1bf77ce31..03da73ca0 100644 --- a/Resources/Documentation/ELSE/gain~.md +++ b/Resources/Documentation/ELSE/gain~.md @@ -29,27 +29,30 @@ flags: - name: -max description: sets max gain (needs to be > 0, default 1) - name: -mode - description: sets scaling mode: 0 (quartic), 1 (dB) or 2 (linear) + description: sets scaling mode; 0 (quartic), 1 (dB) or 2 (linear) default: quartic - name: -ramp description: sets ramp time (minimum 5) default: 20 - - name: -init - description: sets to init mode - default: no init + - name: -savestate + description: save object state + default: 0 methods: - type: set description: sets slider (range is clipped to 0-1) - type: mode - description: scaling mode: 0 (quartic, default), 1 (dB) or 2 (linear) + description: scaling mode; 0 (quartic, default), 1 (dB) or 2 (linear) - type: gain description: sets max gain (values <= 0 are ignored) - type: ramp description: sets ramp time in ms for slider values (default 20) - - type: init - description: non-0 sets to init mode - + - type: savestate + description: non-0 will save object state + - type: learn + description: learns a MIDI controller + - type: forget + description: forgets a MIDI controller draft: false --- diff --git a/Resources/Documentation/ELSE/imp.mc~.md b/Resources/Documentation/ELSE/imp.mc~.md deleted file mode 100644 index b6c1737d0..000000000 --- a/Resources/Documentation/ELSE/imp.mc~.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: imp.mc~ - -description: multichannel impulse oscillator bank - -categories: - - object - -pdcategory: ELSE, Signal Generators - -arguments: -- type: list - description: list of frequencies - default: 0 - -flags: - - name: -sum - description: sums the oscillators into a single channel - -inlets: - 1st: - - type: signals - description: frequency values - 2nd: - - type: signals - description: phase sync - 3rd: - - type: signals - description: phase modulation - -outlets: - 1st: - - type: signals - description: multichannel impulse signal - -methods: - - type: sum - description: non zero sums the oscillators into a single channel - - type: set - description: set frequencies - - -draft: false ---- - -[imp.mc~] takes multichannel signals to set frequencies, phase sync and phase modulation of impulse oscillators. The number of oscillators is defined by the number of channels in the frequency input signal. The output is also a multichannel signal by default, but you can “sum” them into a single channel with the “sum” flag or message. - diff --git a/Resources/Documentation/ELSE/keymap.md b/Resources/Documentation/ELSE/keymap.md index 23c1feb90..9ed38ad9c 100644 --- a/Resources/Documentation/ELSE/keymap.md +++ b/Resources/Documentation/ELSE/keymap.md @@ -8,6 +8,12 @@ categories: pdcategory: ELSE, UI, MIDI arguments: +- description: number of octaves up or down + type: float + default: 0 +- description: non zero sets to toggle mode + type: float + default: 0 inlets: 1st: @@ -22,6 +28,8 @@ outlets: - type: float description: transposition value + + draft: false --- [keymap] maps your computer keyboard to MIDI pitches and generates note diff --git a/Resources/Documentation/ELSE/knob.md b/Resources/Documentation/ELSE/knob.md index 32d03d1ca..1699b7943 100644 --- a/Resources/Documentation/ELSE/knob.md +++ b/Resources/Documentation/ELSE/knob.md @@ -24,8 +24,8 @@ outlets: flags: - name: -set description: sets value (no output) - - name: -init - description: sets initialization value, no float sets current + - name: -load + description: sets load value, no float sets current default: 0 - name: -size description: - sets size in pixels @@ -73,12 +73,14 @@ flags: methods: - type: set description: sets value (no output) - - type: init - description: sets initialization value, no float sets current + - type: load + description: sets load value, no float sets current default: 0 - type: size description: - sets size in pixels default: 50 + - type: start + description: sets arc start value, no float sets current - type: arc description: - non zero sets to arc drawing mode default: 1 diff --git a/Resources/Documentation/ELSE/list.seq.md b/Resources/Documentation/ELSE/list.seq.md new file mode 100644 index 000000000..61e32ec61 --- /dev/null +++ b/Resources/Documentation/ELSE/list.seq.md @@ -0,0 +1,35 @@ +--- +title: list.seq + +description: sequence a list + +categories: + - object +pdcategory: ELSE, Data Management + +arguments: +- type: float + description: list to sequence through + default: 0 + + +inlets: + 1st: + - description: list to sequence through + type: list + - description: output an element list + type: bang + +outlets: + 1st: + - description: the generated incremented list + type: list + +methods: + - type: goto + description: go to an element index (indexed from 1) + +draft: false +--- + +Use [list.seq] to sequence through a list, looping through it. \ No newline at end of file diff --git a/Resources/Documentation/ELSE/loadbanger.md b/Resources/Documentation/ELSE/loadbanger.md index d2152a660..c5a9b9b2e 100644 --- a/Resources/Documentation/ELSE/loadbanger.md +++ b/Resources/Documentation/ELSE/loadbanger.md @@ -26,6 +26,8 @@ outlets: flags: - name: -init description: sets loadbang to "init mode" + - name: -fin + description: sets loadbang to "finalize mode" draft: false --- diff --git a/Resources/Documentation/ELSE/makenote2.md b/Resources/Documentation/ELSE/makenote2.md index 7c2d53904..9371919c7 100644 --- a/Resources/Documentation/ELSE/makenote2.md +++ b/Resources/Documentation/ELSE/makenote2.md @@ -12,6 +12,9 @@ arguments: - type: float description: BPM default: 120 +- type: list + description: extra note-off message parameters + default: none inlets: 1st: diff --git a/Resources/Documentation/ELSE/maxpeak~.md b/Resources/Documentation/ELSE/maxpeak~.md index f1b560504..5240fca51 100644 --- a/Resources/Documentation/ELSE/maxpeak~.md +++ b/Resources/Documentation/ELSE/maxpeak~.md @@ -26,6 +26,10 @@ outlets: - type: bang description: bangs when input gets clipped +methods: +- type: -lin + description: non zero sets to linear output + draft: false --- diff --git a/Resources/Documentation/ELSE/mono~.md b/Resources/Documentation/ELSE/mono~.md new file mode 100644 index 000000000..587c03bfe --- /dev/null +++ b/Resources/Documentation/ELSE/mono~.md @@ -0,0 +1,61 @@ +--- +title: mono~ + +description: monophonic signal voice manager + +categories: + - object +pdcategory: ELSE, Mixing and Routing + +arguments: +- type: float + description: glide time in ms + default: 0 +- type: float + description: non zero sets to legato mode + default: 0 + +inlets: + 1st: + - description: MIDI note pair (note and velocity) + type: list + - description: MIDI note + type: float +2nd: + - description: MIDI velocity + type: float + +outlets: + 1st: + - description: MIDI pitch values + type: signal + 2nd: + - description: velocity values, normalized from 0-1 + type: signal + 3rd: + - description: impulses for retriggering envelopes + type: signal + +flags: + - name: -last + description: select last note + - name: -high + description: select highest note + - name: -low + description: select lowest note + +methods: + - type: glide + description: set glide time in ms + - type: mode + description: sets priority mode, 0=last, 1=high, 2=low + - type: legato + description: non zero sets to legato mode, zero restores default + - type: flush + description: sends a note off for the hanging note and clears memory + - type: clear + description: clear memory without output + +draft: false +--- +[mono~] emulates monophonic synth behaviour and is much like [mono], but can also glide the pitch output with a portamento setting. diff --git a/Resources/Documentation/ELSE/mov.rms~.md b/Resources/Documentation/ELSE/mov.rms~.md index 3d1eefca5..c7837ac33 100644 --- a/Resources/Documentation/ELSE/mov.rms~.md +++ b/Resources/Documentation/ELSE/mov.rms~.md @@ -29,14 +29,17 @@ outlets: flags: - name: -size description: sets buffer size - - name: -db - description: sets output in dBFS + - name: -lin + description: sets output to linear + default: dBFS methods: - type: clear description: clears buffer's memory - type: size description: sets new maximum size and clears buffer's memory + - type: lin + description: non zero sets to linear output draft: false --- diff --git a/Resources/Documentation/ELSE/multi.vsl.md b/Resources/Documentation/ELSE/multi.vsl.md index c7c9b4a13..c762c0da2 100644 --- a/Resources/Documentation/ELSE/multi.vsl.md +++ b/Resources/Documentation/ELSE/multi.vsl.md @@ -41,8 +41,8 @@ flags: - name: -dim description: sets x/y dimensions default: 200 127 - - name: -init - description: non-0 sets to init mode + - name: -savestate + description: non-0 will save object state default: 0 - name: -send description: sets send symbol @@ -94,8 +94,8 @@ methods: description: sets number of sliders and values (and dumps them) - type: export description: outputs sliders values as a list - - type: init - description: non-0 sets to jump on click mode + - type: savestate + description: non-0 will save object state - type: send description: sets send name - type: receive diff --git a/Resources/Documentation/ELSE/nop~.md b/Resources/Documentation/ELSE/nop~.md new file mode 100644 index 000000000..99388d54f --- /dev/null +++ b/Resources/Documentation/ELSE/nop~.md @@ -0,0 +1,24 @@ +--- +title: nop~ + +description: no operation signal bypass + +categories: + - object + +pdcategory: ELSE, Mixing and Routing + +inlets: + 1st: + - type: signel + description: signal to bypass + +outlets: + 1st: + - type: signal + description: bypassed signal + +draft: false +--- + +[nop~] does no operation, that is, it does nothing. It's mostly useful for managing singal cords in your patch. \ No newline at end of file diff --git a/Resources/Documentation/ELSE/note.in.md b/Resources/Documentation/ELSE/note.in.md index 3dd353973..e3604cfff 100644 --- a/Resources/Documentation/ELSE/note.in.md +++ b/Resources/Documentation/ELSE/note.in.md @@ -12,6 +12,7 @@ arguments: - type: float description: sets channel number default: 0 - OMNI + inlets: 1st: - type: float @@ -19,25 +20,28 @@ inlets: 2nd: - type: float description: MIDI channel + outlets: 1st: - - type: float - description: MIDI pitch + - type: list + description: MIDI pitch and note-on velocity 2nd: - - type: float - description: MIDI velocity - 3rd: - - type: float - description: Note on/off flag (if -rel flag is given) - 4th: - - type: float - description: Rightmost outlet is MIDI channel + - type: list + description: MIDI pitch and note-off velocity flags: - name: -rel description: sets the object to output release velocity and note on/off flag +- name: -ext + description: only listen to external input source +- name: -both + description: sets the object to output both note on and off velocity + +methods: +- type: ext + description: nonzero sets to listen only to external input source draft: false --- -[note.in] extracts MIDI Pitch information from raw MIDI input (such as from [midiin]). +[note.in] extracts MIDI Pitch information from external "raw" MIDI data or an internally connected device. It deals with both NoteOn and NoteOff messages (with release velocity). \ No newline at end of file diff --git a/Resources/Documentation/ELSE/note.out.md b/Resources/Documentation/ELSE/note.out.md index ece52c5c9..2fe49bd6c 100644 --- a/Resources/Documentation/ELSE/note.out.md +++ b/Resources/Documentation/ELSE/note.out.md @@ -20,18 +20,19 @@ inlets: 2nd: - type: float description: velocity values - 3rd: - - type: float - description: note on/off flag (if -rel flag is given) + outlets: 1st: - type: float - description: rightmost inlet is MIDI channel + description: raw MIDI stream flags: - name: -rel description: sets the object to output release velocity and note on/off flag +- name: -both + description: sets the object to output both note on and off velocity + draft: false --- -[pitchout] formats and sends raw MIDI pitch messages. An argument sets channel number (the default is 1). +[note.out] formats and sends raw MIDI pitch messages to Pd's MIDI output and its outlet. An argument sets channel number (the default is 1). \ No newline at end of file diff --git a/Resources/Documentation/ELSE/numbox~.md b/Resources/Documentation/ELSE/numbox~.md index 51a83a8d4..f7aba3a78 100644 --- a/Resources/Documentation/ELSE/numbox~.md +++ b/Resources/Documentation/ELSE/numbox~.md @@ -26,8 +26,8 @@ flags: - name: -size description: font size (minimum 8) default: patch's - - name: -init - description: sets initial generating value + - name: -load + description: sets initialization and generating value with given float or sets current value if no float is given. - name: -width description: sets digit width (minimum 1) default: 6 @@ -64,7 +64,9 @@ methods: description: sets ramp time in ms - type: rate description: sets refresh rate in ms - + - type: load + description: sets initial generating value (default 0) + draft: false --- diff --git a/Resources/Documentation/ELSE/order.md b/Resources/Documentation/ELSE/order.md index e76eee58b..3aded3e55 100644 --- a/Resources/Documentation/ELSE/order.md +++ b/Resources/Documentation/ELSE/order.md @@ -18,7 +18,7 @@ arguments: inlets: 1st: - - type: anything + - type: list description: any number of elements to be split and ordered outlets: diff --git a/Resources/Documentation/ELSE/osc.mc~.md b/Resources/Documentation/ELSE/osc.mc~.md deleted file mode 100644 index 24151c03c..000000000 --- a/Resources/Documentation/ELSE/osc.mc~.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: osc.mc~ -description: Multichannel oscillator bank - -categories: - - object - -pdcategory: ELSE, Signal Generators - -arguments: -- type: list - description: list of frequencies - default: 0 - -flags: -- name: -sum - description: sums the oscillators into a single channel - -inlets: - 1st: - - type: signals - description: frequency values - 2nd: - - type: signal - description: phase sync - 3rd: - - type: signal - description: phase modulation - -outlets: - 1st: - - type: signals - description: multichannel signal from oscillator bank - -methods: - - type: sum - description: non zero sums the oscillators into a single channel - - type: set - description: set frequencies - -draft: false ---- - -[osc.mc~] takes multichannel signals to set frequencies, phase sync and phase modulation of sine oscillators. The number of oscillators is defined by the number of channels in the frequency input signal. The output is also a multichannel signal by default, but you can “sum” them into a single channel with the “sum” flag or message. diff --git a/Resources/Documentation/ELSE/oscbank2~.md b/Resources/Documentation/ELSE/oscbank2~.md index 661b06de1..53781b915 100644 --- a/Resources/Documentation/ELSE/oscbank2~.md +++ b/Resources/Documentation/ELSE/oscbank2~.md @@ -8,14 +8,6 @@ categories: pdcategory: ELSE, Signal Generators -arguments: - - description: number of oscillators - type: float - default: 1 - - description: ramp time in ms - type: float - default: 10 - inlets: 1st: - type: freq @@ -46,6 +38,9 @@ flags: - name: -rampall description: sets a ramp time for all oscillators default: all 10 + - name: -mc + description: sets to multichannel output + default: 0 methods: - type: freq @@ -58,6 +53,8 @@ methods: description: list of ramp time for all oscillators in the bank - type: rampall description: sets ramp time for all oscillators + - type: mc + description: sets to multichannel output draft: false --- diff --git a/Resources/Documentation/ELSE/oscbank~.md b/Resources/Documentation/ELSE/oscbank~.md index 757e76cd0..759e61352 100644 --- a/Resources/Documentation/ELSE/oscbank~.md +++ b/Resources/Documentation/ELSE/oscbank~.md @@ -9,15 +9,9 @@ categories: pdcategory: ELSE, Signal Generators arguments: - - description: number of oscillators - type: float - default: 1 - description: fundamental frequency in Hz type: float default: 0 - - description: ramp time in ms - type: float - default: 10 inlets: 1st: @@ -47,6 +41,9 @@ flags: - name: -rampall description: sets a ramp time for all oscillators default: all 10 + - name: -mc + description: sets to multichannel output + default: 0 methods: - type: ratio @@ -59,7 +56,9 @@ methods: description: list of ramp time for all oscillators - type: rampall description: sets ramp time for all oscillators - + - type: mc + description: sets to multichannel output + draft: false --- diff --git a/Resources/Documentation/ELSE/out1~.md b/Resources/Documentation/ELSE/out1~.md deleted file mode 100644 index c06bf8f3e..000000000 --- a/Resources/Documentation/ELSE/out1~.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: out1~ - -description: mono output - -categories: -- object - -pdcategory: ELSE, Audio I/O - -arguments: - - description: max gain (needs to be > 0) - type: float - default: 1 - - description: scaling mode: 0 (quartic), 1 (dB), or 2 (linear) - type: float - default: 0 - -inlets: - 1st: - - type: signal - description: incoming signal routed to a mono output output: [dac~ 1] - - type: float - description: sets slider (range is clipped to 0-1) - -outlets: - -flags: - - name: -ch - description: sets output channel - default: 1 - -methods: - - type: - description: turns DSP Engine (Compute Audio) On or Off - - type: mode - description: scaling mode: 0 (quartic, default), 1 (dB) or 2 (linear) - - type: mute - description: mute/unmute button - - type: gain - description: sets max gain (values <= 0 are ignored) - - type: ramp - description: sets ramp time in ms for slider values (default 20) - -draft: false ---- - -[out1~] is variant of [out~] and a convenient mono output abstraction. It has controls for mute, DSP on/off, ramp time, maximum gain and scaling mode. diff --git a/Resources/Documentation/ELSE/peak~.md b/Resources/Documentation/ELSE/peak~.md index 069736b55..268e05b26 100644 --- a/Resources/Documentation/ELSE/peak~.md +++ b/Resources/Documentation/ELSE/peak~.md @@ -27,16 +27,15 @@ outlets: description: peak amplitude value flags: - - name: -db - description: sets the output to dBFS + - name: -lin + description: sets the output to linear + default: dBFS methods: - type: set description: sets window and hop size in samples - - type: db - description: change peak value to dBFS - - type: linear - description: change peak value to linear (the default is linear) + - type: lin + description: non zero sets to linear output draft: false --- diff --git a/Resources/Documentation/ELSE/pgm.in.md b/Resources/Documentation/ELSE/pgm.in.md index ef0b86931..937678604 100644 --- a/Resources/Documentation/ELSE/pgm.in.md +++ b/Resources/Documentation/ELSE/pgm.in.md @@ -29,6 +29,15 @@ outlets: - type: float description: MIDI channel +methods: +- type: -ext + description: non zero sets to listen only to external input source + +flags: +- name: -ext + description: only listen to external input source + default: no + draft: false --- diff --git a/Resources/Documentation/ELSE/plaits~.md b/Resources/Documentation/ELSE/plaits~.md index cbb42c654..c601d1c09 100644 --- a/Resources/Documentation/ELSE/plaits~.md +++ b/Resources/Documentation/ELSE/plaits~.md @@ -29,8 +29,8 @@ arguments: default: 0.5 flags: - - name: -cv/-midi/-voct - description: set to pitch input in CV, MIDI, or v/oct + - name: -cv/-midi + description: set to pitch input in CV, MIDI default: Hz - name: -model description: set model number @@ -38,13 +38,14 @@ flags: - name: -trigger description: set to trigger mode default: regular + - name: -level + description: enables level input + default: disabled inlets: 1st: - type: float/signal description: pitch input - - type: bang - description: control trigger (when in trigger mode) 2nd: - type: signal description: signal trigger input @@ -70,8 +71,6 @@ methods: description: set frequency mode to MIDI - type: cv description: set frequency mode to CV - - type: voct - description: set frequency mode to v/oct - type: trigger description: non-0 sets to trigger mode - type: model diff --git a/Resources/Documentation/ELSE/pluck~.md b/Resources/Documentation/ELSE/pluck~.md index d4b1469f4..62ec2311f 100644 --- a/Resources/Documentation/ELSE/pluck~.md +++ b/Resources/Documentation/ELSE/pluck~.md @@ -19,14 +19,12 @@ arguments: inlets: 1st: - type: signal - description: trigger (determines the amplitude) - - type: float - description: non-0 triggers and sets amplitude - - type: bang - description: triggers with last control amplitude (default 1) + description: frequency input + - type: list + description: set frequency and trigger value (normalized to MIDI range) 2nd: - type: float/signal - description: frequency in Hz (minimum 1) + description: trigger (determines the maximum amplitude) 3rd: - type: float/signal description: decay time in ms @@ -42,12 +40,19 @@ outlets: - type: signal description: the Karplus-Strong output +methods: + - type: midi + description: non zero sets to MIDI pitch input instead of hz. + flags: - name: -in description: creates an extra right inlet for noise input + - name: -midi + description: sets to MIDI pitch input + draft: false --- -[pluck~] is a Karplus-Strong algorithm with a 1st order lowpass filter in the feedback loop. It takes frequency in Hz, a decay time in ms and a cutoff frequency for the filter. It is triggered by signals at zero to non-0 transitions or by floats and bangs at control rate. +[pluck~] is a Karplus-Strong algorithm with a 1st order lowpass filter in the feedback loop. It takes frequency in hertz or midi, a decay time in ms and a cutoff frequency in hz for the filter. It is triggered by signals at zero to non zero transitions or by lists at control rate. diff --git a/Resources/Documentation/ELSE/pmosc~.md b/Resources/Documentation/ELSE/pmosc~.md deleted file mode 100644 index f2d05562a..000000000 --- a/Resources/Documentation/ELSE/pmosc~.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: pmosc~ -description: phase modulation oscillator pair -categories: - - object -pdcategory: ELSE, Signal Generators - -arguments: -- type: float - description: carrier frequency in Hz - default: 0 -- type: float - description: modulation frequency in Hz - default: 0 -- type: float - description: modulation index - default: 0 -- type: float - description: phase input of modulator oscillator - default: 0 - -inlets: - 1st: - - type: float/signal - description: carrier frequency in Hz - 2nd: - - type: float/signal - description: modulation frequency in Hz - 3rd: - - type: float/signal - description: modulation index - 4th: - - type: float/signal - description: phase input of modulator oscillator - -outlets: - 1st: - - type: signal - description: phase modulation output - -draft: false ---- - -[pmosc~] is a pair of sinusoidal oscillators, where one modulates the phase input of another. - diff --git a/Resources/Documentation/ELSE/ptouch.in.md b/Resources/Documentation/ELSE/ptouch.in.md index 750f400b5..c399bacf9 100644 --- a/Resources/Documentation/ELSE/ptouch.in.md +++ b/Resources/Documentation/ELSE/ptouch.in.md @@ -29,6 +29,15 @@ outlets: - description: MIDI channel type: float +methods: +- type: -ext + description: non zero sets to listen only to external input source + +flags: +- name: -ext + description: only listen to external input source + default: no + draft: false --- diff --git a/Resources/Documentation/ELSE/rampnoise.mc~.md b/Resources/Documentation/ELSE/rampnoise.mc~.md deleted file mode 100644 index 668f5b4b4..000000000 --- a/Resources/Documentation/ELSE/rampnoise.mc~.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: rampnoise.mc~ - -description: multichannel rampnoise bank - -categories: - - object - -pdcategory: ELSE, Signal Generators, Random and Noise - -arguments: -- type: list - description: list of frequencies - -flags: - - name: -sum - description: sums the rampnoises - - name: -seed - description: sets seed value - -inlets: - 1st: - - type: signals - description: frequency values - -outlets: - 1st: - - type: signals - description: multichannel signal from ramp noise bank - -methods: - - type: sum - description: non zero sums the ramp noises into a single channel - - type: seed - description: a float sets seed, no float sets a unique internal - -draft: false ---- - -[rampnoise.mc~] takes multichannel signals to set frequencies of different rampnoise generators. The output is also a multichannel signal by default, but you can “sum” them into a single channel with the “sum” flag or message. - diff --git a/Resources/Documentation/ELSE/rdelay~.md b/Resources/Documentation/ELSE/rdelay~.md deleted file mode 100644 index a78bb73ed..000000000 --- a/Resources/Documentation/ELSE/rdelay~.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: rdelay~ - -description: reverse delay - -categories: -- object - -pdcategory: ELSE, Effects - -arguments: -- type: float - description: initial length - default: 1000 ms - -inlets: - 1st: - - type: signal - description: signal input into the delay line - -outlets: - 1st: - - type: signal - description: the feed forward delayed signal - -methods: - - type: resize - description: changes the delay size - - type: clear - description: clears the delay buffer - -draft: false ---- - -[rdelay~] is a reverse delay effect. It takes a size amount in ms to play backwards from a delay line (default 1000 ms). diff --git a/Resources/Documentation/ELSE/receiver.md b/Resources/Documentation/ELSE/receiver.md index 57187a5bf..e62086ee5 100644 --- a/Resources/Documentation/ELSE/receiver.md +++ b/Resources/Documentation/ELSE/receiver.md @@ -9,6 +9,9 @@ categories: pdcategory: ELSE, Data Management arguments: +- type: optional depth value + description: receive names + default: 1 - type: list description: receive names default: @@ -33,4 +36,4 @@ methods: draft: false --- -[receiver] is much like vanilla's [receive], but can have up to two names and has an inlet to set the receive names. +[receiver] is like vanilla's [receive]. It can have up to two names, has an inlet to set the receive names and at load time can expand dollar symbols according to parent patches. \ No newline at end of file diff --git a/Resources/Documentation/ELSE/resonbank2~.md b/Resources/Documentation/ELSE/resonbank2~.md index c77fa1ba1..fdab64d06 100644 --- a/Resources/Documentation/ELSE/resonbank2~.md +++ b/Resources/Documentation/ELSE/resonbank2~.md @@ -8,14 +8,6 @@ categories: pdcategory: ELSE, Filters, Effects -arguments: -- type: float - description: number of filters - default: 2 -- type: float - description: ramp time in ms - default: 10 - inlets: 1st: - type: signal @@ -39,7 +31,10 @@ flags: description: list of ramp times for all filters - name: -rampall description: sets ramp time for all filters - + - name: -mc + description: sets to multichannel output + default: 0 + methods: - type: freq description: list of frequencies for all filters @@ -53,6 +48,8 @@ methods: description: list of ramp times for all filters - type: rampall description: sets ramp time for all filters + - type: mc + description: sets to multichannel output draft: false --- diff --git a/Resources/Documentation/ELSE/resonbank~.md b/Resources/Documentation/ELSE/resonbank~.md index 5e23e3295..9fb1b4433 100644 --- a/Resources/Documentation/ELSE/resonbank~.md +++ b/Resources/Documentation/ELSE/resonbank~.md @@ -8,14 +8,6 @@ categories: pdcategory: ELSE, Filters, Effects -arguments: -- type: float - description: number of filters - default: 1 -- type: float - description: ramp time in ms - default: 10 - inlets: 1st: - type: signal @@ -39,7 +31,9 @@ flags: description: list of ramp times for all filters - name: -rampall description: sets ramp time for all filters - + - name: -mc + description: sets to multichannel output + default: 0 methods: - type: freq @@ -54,6 +48,8 @@ methods: description: list of ramp times for all filters - type: rampall description: sets ramp time for all filters + - type: mc + description: sets to multichannel output draft: false --- diff --git a/Resources/Documentation/ELSE/rms~.md b/Resources/Documentation/ELSE/rms~.md index 6e3ca4fc6..6047feaae 100644 --- a/Resources/Documentation/ELSE/rms~.md +++ b/Resources/Documentation/ELSE/rms~.md @@ -20,12 +20,19 @@ inlets: 1st: - type: signal description: the signal to analyze - - type: set + +flags: + - name: -size + description: sets buffer size + - name: -lin + description: sets output to linear + default: dBFS + +methods: + - type: set description: sets window and hop size in samples - - type: db - description: change RMS value to dBFS - - type: linear - description: change RMS value to linear + - type: lin + description: non zero sets to linear output outlets: 1st: diff --git a/Resources/Documentation/ELSE/send2~.md b/Resources/Documentation/ELSE/send2~.md new file mode 100644 index 000000000..446b591d9 --- /dev/null +++ b/Resources/Documentation/ELSE/send2~.md @@ -0,0 +1,23 @@ +--- +title: send2~ + +description: multichannel signal send + +categories: + - object +pdcategory: ELSE, Mixing and Routing + +arguments: +- type: float + description: send symbol + default: none + +inlets: + 1st: + - description: signals to send + type: signals + +draft: false +--- + +[send2~] is like send but automatically resizes according to the number of input channels. diff --git a/Resources/Documentation/ELSE/sfz~.md b/Resources/Documentation/ELSE/sfz~.md index 4bf699433..447919779 100644 --- a/Resources/Documentation/ELSE/sfz~.md +++ b/Resources/Documentation/ELSE/sfz~.md @@ -1,7 +1,7 @@ --- title: sfz~ -description: merge multichannel signals +description: hybrid sample player categories: - object diff --git a/Resources/Documentation/ELSE/slider2d.md b/Resources/Documentation/ELSE/slider2d.md index d4ba29afb..37fc110e3 100644 --- a/Resources/Documentation/ELSE/slider2d.md +++ b/Resources/Documentation/ELSE/slider2d.md @@ -34,8 +34,8 @@ flags: - name: -fgcolor description: sets foreground color default: 0 0 0 -- name: -init - description: non-0 sets to init mode +- name: -savestate + description: non-0 will save object state default: 0 @@ -72,8 +72,8 @@ methods: description: sets background color in RGB - type: fgcolor description: sets foreground color in RGB -- type: init - description: non-0 sets to init mode +- type: savestate + description: non-0 will save object state draft: false --- diff --git a/Resources/Documentation/ELSE/stepnoise.mc~.md b/Resources/Documentation/ELSE/stepnoise.mc~.md deleted file mode 100644 index 6c5860203..000000000 --- a/Resources/Documentation/ELSE/stepnoise.mc~.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: stepnoise.mc~ - -description: multichannel stepnoise bank - -categories: - - object - -pdcategory: ELSE, Random and Noise, Signal Generators - -arguments: -- type: list - description: list of frequencies - -flags: -- name: -sum - description: sums the step noises -- name: -seed - description: sets seed value - default: unique internal - -inlets: - 1st: - - type: signals - description: frequency values - -outlets: - 1st: - - type: signal - description: multichannel signal from stepnoise bank - -methods: - - type: sum - description: non zero sums the step noises into a single channel - - type: seed - description: a float sets seed, no float sets a unique internal - -draft: false ---- - -[stepnoise.mc~] takes multichannel signals to set frequencies of different stepnoise generators. The output is also a multichannel signal by default, but you can “sum” them into a single channel with the “sum” flag or message. diff --git a/Resources/Documentation/ELSE/touch.in.md b/Resources/Documentation/ELSE/touch.in.md index 6864568be..27383c40d 100644 --- a/Resources/Documentation/ELSE/touch.in.md +++ b/Resources/Documentation/ELSE/touch.in.md @@ -13,10 +13,10 @@ arguments: description: sets channel number default: 0 - OMNI -flags: -- name: -poly - description: sets the object to output polyphonic aftertouch - +methods: +- type: -ext + description: non zero sets to listen only to external input source + inlets: 1st: - type: float @@ -33,6 +33,11 @@ outlets: - type: float description: MIDI channel +flags: +- name: -ext + description: only listen to external input source + default: no + draft: false --- diff --git a/Resources/Documentation/ELSE/touch.out.md b/Resources/Documentation/ELSE/touch.out.md index 29fd5987d..5e8ebeeca 100644 --- a/Resources/Documentation/ELSE/touch.out.md +++ b/Resources/Documentation/ELSE/touch.out.md @@ -13,10 +13,6 @@ arguments: description: sets channel number default: 1 -flags: -- name: -poly - description: sets the object to output polyphonic aftertouch - inlets: 1st: - type: float diff --git a/Resources/Documentation/ELSE/var.md b/Resources/Documentation/ELSE/var.md new file mode 100644 index 000000000..6e94735b0 --- /dev/null +++ b/Resources/Documentation/ELSE/var.md @@ -0,0 +1,28 @@ +--- +title: var + +description: store one or more variables + +categories: + - object +pdcategory: ELSE, Mixing and Routing + +arguments: +- type: list + description: list of variable names + default: none + +inlets: + 1st: + - description: input values to given variables + type: list + +outlets: + 1st: + - description: values to given variables + type: list + +draft: false +--- + +[var] is similar to [value] but it can set and recall more than one variable as lists. diff --git a/Resources/Documentation/ELSE/voices.md b/Resources/Documentation/ELSE/voices.md index 55d5ceeec..92069164f 100644 --- a/Resources/Documentation/ELSE/voices.md +++ b/Resources/Documentation/ELSE/voices.md @@ -28,13 +28,10 @@ flags: inlets: 1st: - type: list - description: MIDI note messages (note and velocity pair) - - type: float - description: note pitch values + description: MIDI note and velocity pair + - type: anything + description: other cutom messages to route to active voices 2nd: - - type: float - description: note velocity values - 3rd: - type: float description: release time in ms diff --git a/Source/Components/SuggestionComponent.h b/Source/Components/SuggestionComponent.h index 3f2e2dd2b..bba1350c2 100644 --- a/Source/Components/SuggestionComponent.h +++ b/Source/Components/SuggestionComponent.h @@ -944,7 +944,8 @@ class SuggestionComponent : public Component "libpd_receive", "out.mc.hip~", "pvoc~", - "gran~" + "gran~", + "convpartition" }; int windowMargin;