Merge pull request #1568 from tildearrow/doc-channelstatus

Docs for channel status indicators.

doc/3-pattern/README.md

@@ -38,18 +38,39 @@ 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 menu to set view modes:
+- **Effect columns/collapse**: as shown above. adds the following buttons beneath the channel name:
   - **-**: 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 when channels are paired in some way (e.g. OPL3 4-op mode).
+- **Visualizer**: during playback, show visual effects in the pattern view.
+  - also can be toggled by right-clicking on the `++` button.
+- **Channel status**: displays icons that indicate activity in the channel. see the "channel status" section below.
 
 to rename and/or hide channels, open [the Channels window](../8-advanced/channels.md) via the window menu.
 
+### channel status
+
+  - 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.
+
 
 ## input
 

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, the reason 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) test bit enabled
+- ![ch3off enabled in filter mode](status-C64-ch3off.png) ch3off enabled in filter mode

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 whether noise mode is enabled:
+- ![noise mode off](status-PCE-noise-off.png) noise mode off
+- ![noise mode on](status-PCE-noise-on.png) noise mode on

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 or 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
 

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 channel mode:
+
+- ![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