diff --git a/doc/3-pattern/README.md b/doc/3-pattern/README.md index f619ce287..89e1f6e5d 100644 --- a/doc/3-pattern/README.md +++ b/doc/3-pattern/README.md @@ -38,15 +38,33 @@ clicking on a channel name mutes that channel. double-clicking or right-clicking it enables solo mode, in which only that channel will be audible. -clicking the `++` at the top left corner of the pattern view cycles through three channel bar view modes: -- **Compact**: shows only channel names. -- **Expanded**: as shown above. adds buttons: +clicking the `++` at the top left corner of the pattern view pops up a small dialog to set view modes: +- **Effect columns/collapse**: as shown above. adds buttons: - **-**: collapse visible columns. changes to **+** when columns are hidden; click to expand them. - **<**: disables the last effect column and hides it. effects are not deleted... - **>**: adds an effects column. if one previously existed, its contents will be preserved. - **Pattern names**: displays pattern names (per channel). pattern names are also visible when hovering over a pattern in the order list. - -right-clicking the `++` toggles the visualizer, which is active only during playback. +- **Channel group hints**: display indicators beneath the names of channels that function together in some way. +- **Visualizer**: during playback, show visual effects depending on activity in each channel. + - also can be toggled by a right-click on the `++` button. +- **Channel status**: a bar with icons that indicate activity in the channel. + - note status: + - ![note off](status-note-off.png) note off + - ![note on](status-note-on.png) note on + - ![note on, macro released](status-note-on-rel.png) note on, macro released + - ![note released](status-note-off-rel.png) note released + - pitch effect: + - ![no effect](status-pitch-none.png) no effect + - ![pitch up](status-pitch-up.png) pitch up + - ![pitch down](status-pitch-down.png) pitch down + - ![portamento](status-pitch-porta.png) portamento + - ![arpeggio](status-pitch-arpeg.png) arpeggio + - volume effect: + - ![no effect](status-volume-none.png) no effect + - ![volume up](status-volume-up.png) volume up + - ![volume down](status-volume-down.png) volume down + - ![tremolo](status-volume-tremolo.png) tremolo + - other icons depending on chip. to rename and/or hide channels, open [the Channels window](../8-advanced/channels.md) via the window menu. diff --git a/doc/3-pattern/status-note-off-rel.png b/doc/3-pattern/status-note-off-rel.png new file mode 100644 index 000000000..c522cf6ed Binary files /dev/null and b/doc/3-pattern/status-note-off-rel.png differ diff --git a/doc/3-pattern/status-note-off.png b/doc/3-pattern/status-note-off.png new file mode 100644 index 000000000..817a0c75c Binary files /dev/null and b/doc/3-pattern/status-note-off.png differ diff --git a/doc/3-pattern/status-note-on-rel.png b/doc/3-pattern/status-note-on-rel.png new file mode 100644 index 000000000..bb9e4160e Binary files /dev/null and b/doc/3-pattern/status-note-on-rel.png differ diff --git a/doc/3-pattern/status-note-on.png b/doc/3-pattern/status-note-on.png new file mode 100644 index 000000000..92de9979b Binary files /dev/null and b/doc/3-pattern/status-note-on.png differ diff --git a/doc/3-pattern/status-pitch-arpeg.png b/doc/3-pattern/status-pitch-arpeg.png new file mode 100644 index 000000000..67cd4b52f Binary files /dev/null and b/doc/3-pattern/status-pitch-arpeg.png differ diff --git a/doc/3-pattern/status-pitch-down.png b/doc/3-pattern/status-pitch-down.png new file mode 100644 index 000000000..1a2f9f2b1 Binary files /dev/null and b/doc/3-pattern/status-pitch-down.png differ diff --git a/doc/3-pattern/status-pitch-none.png b/doc/3-pattern/status-pitch-none.png new file mode 100644 index 000000000..21b9d1871 Binary files /dev/null and b/doc/3-pattern/status-pitch-none.png differ diff --git a/doc/3-pattern/status-pitch-porta.png b/doc/3-pattern/status-pitch-porta.png new file mode 100644 index 000000000..ab06ba0d2 Binary files /dev/null and b/doc/3-pattern/status-pitch-porta.png differ diff --git a/doc/3-pattern/status-pitch-up.png b/doc/3-pattern/status-pitch-up.png new file mode 100644 index 000000000..51a0e6f50 Binary files /dev/null and b/doc/3-pattern/status-pitch-up.png differ diff --git a/doc/3-pattern/status-volume-down.png b/doc/3-pattern/status-volume-down.png new file mode 100644 index 000000000..a788b4ea8 Binary files /dev/null and b/doc/3-pattern/status-volume-down.png differ diff --git a/doc/3-pattern/status-volume-none.png b/doc/3-pattern/status-volume-none.png new file mode 100644 index 000000000..bbf32e95e Binary files /dev/null and b/doc/3-pattern/status-volume-none.png differ diff --git a/doc/3-pattern/status-volume-tremolo.png b/doc/3-pattern/status-volume-tremolo.png new file mode 100644 index 000000000..a1fe64d51 Binary files /dev/null and b/doc/3-pattern/status-volume-tremolo.png differ diff --git a/doc/3-pattern/status-volume-up.png b/doc/3-pattern/status-volume-up.png new file mode 100644 index 000000000..525b8add1 Binary files /dev/null and b/doc/3-pattern/status-volume-up.png differ diff --git a/doc/7-systems/c64.md b/doc/7-systems/c64.md index 1688f5e70..ba1d0fcf0 100644 --- a/doc/7-systems/c64.md +++ b/doc/7-systems/c64.md @@ -68,3 +68,13 @@ two versions of aforementioned chip exist - 6581 (original chip) and 8580 (impro ## info this chip uses the [C64](../4-instrument/c64.md) instrument editor. + +## channel status + +when enabled, channel status will show an additional icon representing whether currently playing note is audible, and if not, why it is muted: + +- ![not muted](status-C64-none.png) not muted +- ![gate bit disabled](status-C64-gate-off.png) gate bit disabled +- ![gate bit disabled and test bit enabled](status-C64-gate-off-test-on.png) gate bit disabled and test bit enabled +- ![text bit enabled](status-C64-test-on.png) text bit enabled +- ![ch3off enabled in filter mode](status-C64-ch3off.png) ch3off enabled in filter mode diff --git a/doc/7-systems/pce.md b/doc/7-systems/pce.md index ec6633c3e..9948f21e7 100644 --- a/doc/7-systems/pce.md +++ b/doc/7-systems/pce.md @@ -19,8 +19,14 @@ furthermore, it has some PCM and LFO! - when LFO is enabled, channel 2 is muted and its output is passed to channel 1's frequency. - `13xx`: **set LFO speed.** - `17xx`: **toggle LEGACY sample mode.** - - **this effect exists only for compatibility reasons! its use is NOT recommented. use Sample type instruments instead.** + - **this effect exists only for compatibility reasons! its use is NOT recommended. use Sample type instruments instead.** ## info this chip uses the [PC Engine](../4-instrument/pce.md) instrument editor. + +## channel status + +when enabled, channel status will show an additional icon representing the noise mode of the currently playing note: +- ![noise mode off](status-PCE-noise-off.png) noise mode off +- ![noise mode on](status-PCE-noise-on.png) noise mode on diff --git a/doc/7-systems/snes.md b/doc/7-systems/snes.md index cf518a0d9..a8414f87f 100644 --- a/doc/7-systems/snes.md +++ b/doc/7-systems/snes.md @@ -65,6 +65,18 @@ Furnace also allows the SNES to use wavetables (and the wavetable synthesizer) i this chip uses the [SNES](../4-instrument/snes.md) instrument editor. +## channel status + +when enabled, channel status will show an additional icon representing the gain mode and envelope status of the currently playing note: +- ![direct gain, envelope off](status-SNES-gain-direct.png) direct gain, envelope off +- ![linear gain decrease](status-SNES-gain-dec-lin.png) linear gain decrease +- ![logarithmic gain decrease](status-SNES-gain-dec-log.png) logarithmic gain decrease +- ![linear gain increase](status-SNES-gain-inc-lin.png) linear gain increase +- ![bent-line gain increase](status-SNES-gain-inc-bent.png) bent-line gain increase +- ![envelope attack](status-SNES-env-A.png) envelope attack +- ![envelope decay](status-SNES-env-D.png) envelope decay +- ![envelope sustain](status-SNES-env-S.png) envelope sustain +- ![envelope release](status-SNES-env-R.png) envelope release ## ADSR diff --git a/doc/7-systems/status-C64-ch3off.png b/doc/7-systems/status-C64-ch3off.png new file mode 100644 index 000000000..8fd21961a Binary files /dev/null and b/doc/7-systems/status-C64-ch3off.png differ diff --git a/doc/7-systems/status-C64-gate-off-test-on.png b/doc/7-systems/status-C64-gate-off-test-on.png new file mode 100644 index 000000000..d3aab0688 Binary files /dev/null and b/doc/7-systems/status-C64-gate-off-test-on.png differ diff --git a/doc/7-systems/status-C64-gate-off.png b/doc/7-systems/status-C64-gate-off.png new file mode 100644 index 000000000..fc53a30e9 Binary files /dev/null and b/doc/7-systems/status-C64-gate-off.png differ diff --git a/doc/7-systems/status-C64-none.png b/doc/7-systems/status-C64-none.png new file mode 100644 index 000000000..d1fafa859 Binary files /dev/null and b/doc/7-systems/status-C64-none.png differ diff --git a/doc/7-systems/status-C64-test-on.png b/doc/7-systems/status-C64-test-on.png new file mode 100644 index 000000000..132d39117 Binary files /dev/null and b/doc/7-systems/status-C64-test-on.png differ diff --git a/doc/7-systems/status-PCE-noise-off.png b/doc/7-systems/status-PCE-noise-off.png new file mode 100644 index 000000000..874c8606c Binary files /dev/null and b/doc/7-systems/status-PCE-noise-off.png differ diff --git a/doc/7-systems/status-PCE-noise-on.png b/doc/7-systems/status-PCE-noise-on.png new file mode 100644 index 000000000..373022d41 Binary files /dev/null and b/doc/7-systems/status-PCE-noise-on.png differ diff --git a/doc/7-systems/status-SNES-env-A.png b/doc/7-systems/status-SNES-env-A.png new file mode 100644 index 000000000..60abd875b Binary files /dev/null and b/doc/7-systems/status-SNES-env-A.png differ diff --git a/doc/7-systems/status-SNES-env-D.png b/doc/7-systems/status-SNES-env-D.png new file mode 100644 index 000000000..e52b20784 Binary files /dev/null and b/doc/7-systems/status-SNES-env-D.png differ diff --git a/doc/7-systems/status-SNES-env-R.png b/doc/7-systems/status-SNES-env-R.png new file mode 100644 index 000000000..635121059 Binary files /dev/null and b/doc/7-systems/status-SNES-env-R.png differ diff --git a/doc/7-systems/status-SNES-env-S.png b/doc/7-systems/status-SNES-env-S.png new file mode 100644 index 000000000..0cdce9ea4 Binary files /dev/null and b/doc/7-systems/status-SNES-env-S.png differ diff --git a/doc/7-systems/status-SNES-gain-dec-lin.png b/doc/7-systems/status-SNES-gain-dec-lin.png new file mode 100644 index 000000000..5ad203ed5 Binary files /dev/null and b/doc/7-systems/status-SNES-gain-dec-lin.png differ diff --git a/doc/7-systems/status-SNES-gain-dec-log.png b/doc/7-systems/status-SNES-gain-dec-log.png new file mode 100644 index 000000000..d48907bde Binary files /dev/null and b/doc/7-systems/status-SNES-gain-dec-log.png differ diff --git a/doc/7-systems/status-SNES-gain-direct.png b/doc/7-systems/status-SNES-gain-direct.png new file mode 100644 index 000000000..6c5fd6422 Binary files /dev/null and b/doc/7-systems/status-SNES-gain-direct.png differ diff --git a/doc/7-systems/status-SNES-gain-inc-bent.png b/doc/7-systems/status-SNES-gain-inc-bent.png new file mode 100644 index 000000000..6d41a56d7 Binary files /dev/null and b/doc/7-systems/status-SNES-gain-inc-bent.png differ diff --git a/doc/7-systems/status-SNES-gain-inc-lin.png b/doc/7-systems/status-SNES-gain-inc-lin.png new file mode 100644 index 000000000..e10d8a9ed Binary files /dev/null and b/doc/7-systems/status-SNES-gain-inc-lin.png differ diff --git a/doc/7-systems/status-Swan-PCM-off.png b/doc/7-systems/status-Swan-PCM-off.png new file mode 100644 index 000000000..4596bb70c Binary files /dev/null and b/doc/7-systems/status-Swan-PCM-off.png differ diff --git a/doc/7-systems/status-Swan-PCM-on.png b/doc/7-systems/status-Swan-PCM-on.png new file mode 100644 index 000000000..a03699f1b Binary files /dev/null and b/doc/7-systems/status-Swan-PCM-on.png differ diff --git a/doc/7-systems/status-Swan-noise-off.png b/doc/7-systems/status-Swan-noise-off.png new file mode 100644 index 000000000..874c8606c Binary files /dev/null and b/doc/7-systems/status-Swan-noise-off.png differ diff --git a/doc/7-systems/status-Swan-noise-on.png b/doc/7-systems/status-Swan-noise-on.png new file mode 100644 index 000000000..373022d41 Binary files /dev/null and b/doc/7-systems/status-Swan-noise-on.png differ diff --git a/doc/7-systems/status-Swan-sweep-off.png b/doc/7-systems/status-Swan-sweep-off.png new file mode 100644 index 000000000..aaa5246b6 Binary files /dev/null and b/doc/7-systems/status-Swan-sweep-off.png differ diff --git a/doc/7-systems/status-Swan-sweep-on.png b/doc/7-systems/status-Swan-sweep-on.png new file mode 100644 index 000000000..cb968d48f Binary files /dev/null and b/doc/7-systems/status-Swan-sweep-on.png differ diff --git a/doc/7-systems/wonderswan.md b/doc/7-systems/wonderswan.md index edd189649..287ca7136 100644 --- a/doc/7-systems/wonderswan.md +++ b/doc/7-systems/wonderswan.md @@ -24,3 +24,14 @@ it has 4 wavetable channels. some of them have additional capabilities: ## info this chip uses the [WonderSwan](../4-instrument/wonderswan.md) instrument editor. + +## channel status + +when enabled, channel status will show an additional icon representing the mode of the currently playing note: + +- ![PCM mode off](status-Swan-PCM-off.png) PCM mode off +- ![PCM mode on](status-Swan-PCM-on.png) PCM mode on +- ![sweep mode off](status-Swan-sweep-off.png) sweep mode off +- ![sweep mode on](status-Swan-sweep-on.png) sweep mode on +- ![noise mode off](status-Swan-noise-off.png) noise mode off +- ![noise mode on](status-Swan-noise-on.png) noise mode on