Doc clipped and bitmask macro editors.

"Clipped" meaning the arpeggio and pitch editors that can have values outside the viewed bounds.
This commit is contained in:
Electric Keet 2023-10-30 15:51:41 -07:00
parent d472666e0c
commit 8334582bed
4 changed files with 23 additions and 5 deletions

View file

@ -47,6 +47,7 @@ settings are saved when clicking the **OK** or **Apply** buttons at the bottom o
- **When creating new song**: - **When creating new song**:
- **Display system preset selector** - **Display system preset selector**
- **Start with initial system** - **Start with initial system**
- **Default author name**
### Start-up ### Start-up
@ -92,7 +93,7 @@ settings are saved when clicking the **OK** or **Apply** buttons at the bottom o
- setting this to a high value increases latency. - setting this to a high value increases latency.
- **Exclusive mode**: enables Exclusive Mode, which may offer latency improvements. - **Exclusive mode**: enables Exclusive Mode, which may offer latency improvements.
- only available on WASAPI devices in the PortAudio backend! - only available on WASAPI devices in the PortAudio backend!
- **Low-latency mode (experimental!)**: reduces latency by running the engine faster than the tick rate. useful for live playback/jam mode. - **Low-latency mode**: reduces latency by running the engine faster than the tick rate. useful for live playback/jam mode.
- only enable if your buffer size is small (10ms or less). - only enable if your buffer size is small (10ms or less).
- **Force mono audio**: use if you're unable to hear stereo audio (e.g. single speaker or hearing loss in one ear). - **Force mono audio**: use if you're unable to hear stereo audio (e.g. single speaker or hearing loss in one ear).
- **want:** displays requested audio configuration. - **want:** displays requested audio configuration.
@ -104,6 +105,7 @@ settings are saved when clicking the **OK** or **Apply** buttons at the bottom o
- **Software clipping**: clips output to nominal range (-1.0 to 1.0) before passing it to the audio device. - **Software clipping**: clips output to nominal range (-1.0 to 1.0) before passing it to the audio device.
- this avoids activating Windows' built-in limiter. - this avoids activating Windows' built-in limiter.
- this option shall be enabled when using PortAudio backend with a DirectSound device. - this option shall be enabled when using PortAudio backend with a DirectSound device.
- **DC offset correction**: apply a filter to remove DC bias, where the output is overall above or below zero. default is on.
### Metronome ### Metronome
@ -299,6 +301,9 @@ below all the binds, select a key from the dropdown list to add it. it will appe
- applies when playback is stopped. - applies when playback is stopped.
- **Don't scroll when moving cursor** - **Don't scroll when moving cursor**
- **Move cursor with scroll wheel** - **Move cursor with scroll wheel**
- **No**
- **Yes**
- **Inverted**
## Appearance ## Appearance

View file

@ -96,24 +96,37 @@ every macro can be defined though one of three methods, selectable with the left
- ![ADSR](macro-button-ADSR.png) **ADSR:** this is a traditional ADSR envelope, defined by the rate of increase and decrease of value over time. - ![ADSR](macro-button-ADSR.png) **ADSR:** this is a traditional ADSR envelope, defined by the rate of increase and decrease of value over time.
- ![LFO](macro-button-LFO.png) **LFO:** the Low Frequency Oscillator generates a repeating wave of values. - ![LFO](macro-button-LFO.png) **LFO:** the Low Frequency Oscillator generates a repeating wave of values.
some macros are "bitmap" style. they represent a number of "bits" that can be toggled individually, and the values listed represent the sum of which bits are turned on.
### sequence ### sequence
![sequence macro editor](macro-seq.png) ![sequence macro editor](macro-seq.png)
![clipped sequence macro editor](macro-seq-clip.png)
![bitmask sequence macro editor](macro-seq-bitmask.png)
the number between the macro type label and the macro type button is the macro length in steps. the `-` and `+` buttons change the length of the macro. start out by adding at least a few steps. the number between the macro type label and the macro type button is the macro length in steps. the `-` and `+` buttons change the length of the macro. start out by adding at least a few steps.
the values of the macro can be drawn in the "bar graph" box. the values of the macro can be drawn in the "bar graph" box.
- arpeggio and pitch macros may have values above or below the visible area; small chevrons will be shown until they are scrolled into view.
- bitmask-style macros show labels for each of their bits, and these are edited as toggles.
just beneath the box is a shorter bar that controls looping. arpeggio macros have a short bar for setting whether to interpret the values as being "relative" or "fixed".
- by default, values are offsets **relative** to the note.
- if clicked on, a value becomes **fixed** and will be played at its corresponding note without regard to the note entered into the pattern.
- values are counted from `C-0`. for example, a fixed value of 48 produces a `C-4` note.
- fixed values are especially useful for noise instruments with preset periods.
below this is a short bar that controls looping.
- click to set the start point of a loop; the end point is the last value or release point. it appears as half-height bars. right-click to remove the loop. - click to set the start point of a loop; the end point is the last value or release point. it appears as half-height bars. right-click to remove the loop.
- shift-click to set the release point. when played, the macro will hold here until the note is released. it appears as a full-height bar. right-click to remove the release point. - shift-click to set the release point. when played, the macro will hold here until the note is released. it appears as a full-height bar. right-click to remove the release point.
finally, the sequence of values can be directly edited in the text box at the bottom. finally, the sequence of values can be directly edited in the text box at the bottom.
- the loop start is entered as a `|`. - the loop start is entered as a `|`.
- the release point is entered as a `/`. - the release point is entered as a `/`.
- in arpeggio macros, a value starting with a `@` is an absolute note (instead of a relative shift). no matter the note entered in the pattern, `@` values will be played at that exact note. this is especially useful for noise instruments with preset periods. - in arpeggio macros, a value starting with a `@` is a fixed value as described above.
- in bitmask-style macros, the values are added up in binary and converted to decimal. see [the hexadecimal guide](../1-intro/hex.md) for more info.
### ADSR ### ADSR

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB