Skip to content

Commit

Permalink
Updated ELSE .md files with latest changes and new objects
Browse files Browse the repository at this point in the history
  • Loading branch information
timothyschoen committed Nov 9, 2023
1 parent 5c9a360 commit de71b7c
Show file tree
Hide file tree
Showing 54 changed files with 456 additions and 444 deletions.
12 changes: 8 additions & 4 deletions Resources/Documentation/ELSE/adsr~.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -59,7 +62,8 @@ outlets:
methods:
- type: lin <float>
description: non-0 sets to "lin" mode, "log" otherwise

- type: gate <float>
description: control gate values
draft: false
---

Expand Down
8 changes: 8 additions & 0 deletions Resources/Documentation/ELSE/bend.in.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,16 @@ arguments:
description: sets channel number
default: 0 - OMNI

methods:
- type: -ext <float>
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:
Expand All @@ -33,6 +40,7 @@ outlets:
- type: float
description: MIDI channel


draft: false
---

Expand Down
5 changes: 4 additions & 1 deletion Resources/Documentation/ELSE/bpbank~.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,10 @@ methods:
description: list of ramp time for all filters in the bank
- type: rampal <float>
description: ramp time for all filters in the bank

- name: -mc <float>
description: sets to multichannel output
default: 0

draft: false
---

Expand Down
8 changes: 4 additions & 4 deletions Resources/Documentation/ELSE/circle.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ methods:
description: sets both background colors in RGB
- type: fgcolor <f, f, f>
description: sets foreground color in RGB
- type: init <float>
description: non-0 sets to init mode
- type: savestate <float>
description: non-0 will save object state
- type: clip <float>
description: non-0 clips inside the circle

Expand All @@ -63,8 +63,8 @@ flags:
- name: -grid <float>
description: non-0 sets grid visibility
default: 0
- name: -init <float>
description: non-0 sets to init mode
- name: -savestate <float>
description: non-0 sets will save object state
default: 0
- name: -range <f, f>
description: sets range (minimum and maximum values of x and y)
Expand Down
8 changes: 5 additions & 3 deletions Resources/Documentation/ELSE/conv~.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -29,8 +29,10 @@ outlets:
methods:
- type: size <float>
description: sets partition size
- type: load <symbol>
description: loads IR sound file
- type: set <symbol>
description: load IR table
- type: print
description: print convolution info to console

draft: false
---
Expand Down
4 changes: 2 additions & 2 deletions Resources/Documentation/ELSE/crusher~.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
25 changes: 25 additions & 0 deletions Resources/Documentation/ELSE/dispatch.md
Original file line number Diff line number Diff line change
@@ -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).
4 changes: 4 additions & 0 deletions Resources/Documentation/ELSE/display.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,10 @@ outlets:
- type: anything
description: any input is passed through

flags:
- name: -noflash
description: prevents flashing when getting data.

draft: false
---

Expand Down
3 changes: 3 additions & 0 deletions Resources/Documentation/ELSE/envgen~.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion Resources/Documentation/ELSE/fbsine~.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ arguments:
default: 0
- type: float
description: mean filter: on <1> or off <0>
default: 0
default: 1

inlets:
1st:
Expand Down
37 changes: 37 additions & 0 deletions Resources/Documentation/ELSE/fm~.md
Original file line number Diff line number Diff line change
@@ -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.
10 changes: 6 additions & 4 deletions Resources/Documentation/ELSE/function.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,9 @@ flags:
description: default 0
- name: -max <float>
description: default 1
- name: -init
description:
- name: -savestate
description: save object state
default: 0
- name: -set <list>
description: default 0 1000 0

Expand Down Expand Up @@ -72,8 +73,9 @@ methods:
description: sets send symbol
- type: receive <symbol>
description: sets receive symbol
- type: init <float>
description: non-0 sets to init mode
- type: savestate <float>
description: non-0 will save object state


draft: false
---
Expand Down
19 changes: 11 additions & 8 deletions Resources/Documentation/ELSE/gain2~.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,27 +36,30 @@ flags:
description: sets max gain (needs to be > 0)
default: 1
- name: -mode <float>
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 <float>
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 <float>
description: sets slider (range is clipped to 0-1)
- type: mode <float>
description: scaling mode: 0 (quartic, default), 1 (dB) or 2 (linear)
description: scaling mode; 0 (quartic, default), 1 (dB) or 2 (linear)
- type: gain <float>
description: sets max gain (values <= 0 are ignored)
- type: ramp <float>
description: sets ramp time in ms for slider values (default 20)
- type: init <float>
description: non-0 sets to init mode

- type: savestate <float>
description: non-0 will save object state
- type: learn
description: learns a MIDI controller
- type: forget
description: forgets a MIDI controller
draft: false
---

Expand Down
19 changes: 11 additions & 8 deletions Resources/Documentation/ELSE/gain~.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,27 +29,30 @@ flags:
- name: -max <float>
description: sets max gain (needs to be > 0, default 1)
- name: -mode <float>
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 <float>
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 <float>
description: sets slider (range is clipped to 0-1)
- type: mode <float>
description: scaling mode: 0 (quartic, default), 1 (dB) or 2 (linear)
description: scaling mode; 0 (quartic, default), 1 (dB) or 2 (linear)
- type: gain <float>
description: sets max gain (values <= 0 are ignored)
- type: ramp <float>
description: sets ramp time in ms for slider values (default 20)
- type: init <float>
description: non-0 sets to init mode

- type: savestate <float>
description: non-0 will save object state
- type: learn
description: learns a MIDI controller
- type: forget
description: forgets a MIDI controller
draft: false
---

Expand Down
47 changes: 0 additions & 47 deletions Resources/Documentation/ELSE/imp.mc~.md

This file was deleted.

8 changes: 8 additions & 0 deletions Resources/Documentation/ELSE/keymap.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -22,6 +28,8 @@ outlets:
- type: float
description: transposition value



draft: false
---
[keymap] maps your computer keyboard to MIDI pitches and generates note
Expand Down
Loading

0 comments on commit de71b7c

Please sign in to comment.