add parameters help

xaviergodart · xaviergodart · commit 0a9348e15acf · 2024-12-02T20:53:57.000+01:00
diff --git a/midi/midi.go b/midi/midi.go
@@ -78,6 +78,11 @@ func Note(note uint8) string {
 	return gomidi.Note(note).String()
 }
 
+// CC retruns the string representation of a cc message
+func CC(controller uint8) string {
+	return gomidi.ControlChangeName[controller]
+}
+
 func (m *midi) start() {
 	var wg sync.WaitGroup
 	wg.Add(len(m.devices))
diff --git a/ui/param/bank_cmd.go b/ui/param/bank_cmd.go
@@ -19,6 +19,10 @@ func (b BankCmd) Name() string {
 	return "bank"
 }
 
+func (b BankCmd) Help() string {
+	return ""
+}
+
 func (b BankCmd) Display() string {
 	if !b.nodes[0].(music.Audible).Note().MetaCommands[bankCmdIndex].Active() {
 		return "⨯"
diff --git a/ui/param/cc.go b/ui/param/cc.go
@@ -3,9 +3,11 @@ package param
 import (
 	"fmt"
 	"strconv"
+	"strings"
 
 	"signls/core/common"
 	"signls/core/music"
+	"signls/midi"
 	"signls/ui/util"
 )
 
@@ -29,6 +31,21 @@ func (c CC) Name() string {
 	}
 }
 
+func (c CC) Help() string {
+	switch c.nodes[0].(music.Audible).Note().Controls[c.index].Type {
+	case music.ControlChangeControlType:
+		return strings.ToLower(midi.CC(c.nodes[0].(music.Audible).Note().Controls[c.index].Controller))
+	case music.AfterTouchControlType:
+		return "after touch"
+	case music.PitchBendControlType:
+		return "pitch bend"
+	case music.ProgramChangeControlType:
+		return "program change"
+	default:
+		return ""
+	}
+}
+
 func (c CC) Display() string {
 	if c.nodes[0].(music.Audible).Note().Controls[c.index].Type == music.SilentControlType {
 		return "⨯"
diff --git a/ui/param/channel.go b/ui/param/channel.go
@@ -17,6 +17,10 @@ func (c Channel) Name() string {
 	return "cha"
 }
 
+func (c Channel) Help() string {
+	return ""
+}
+
 func (c Channel) Display() string {
 	if c.nodes[0].(music.Audible).Note().Channel.RandomAmount() != 0 {
 		return util.Normalize(
diff --git a/ui/param/clock_send.go b/ui/param/clock_send.go
@@ -12,6 +12,10 @@ func (c ClockSend) Name() string {
 	return "clock"
 }
 
+func (c ClockSend) Help() string {
+	return ""
+}
+
 func (c ClockSend) Display() string {
 	if c.grid.SendClock {
 		return "on"
diff --git a/ui/param/default_device.go b/ui/param/default_device.go
@@ -12,6 +12,10 @@ func (d DefaultDevice) Name() string {
 	return "device"
 }
 
+func (d DefaultDevice) Help() string {
+	return ""
+}
+
 func (d DefaultDevice) Display() string {
 	return d.grid.MidiDevice()
 }
diff --git a/ui/param/destination.go b/ui/param/destination.go
@@ -19,6 +19,10 @@ func (d Destination) Name() string {
 	return "dest"
 }
 
+func (s Destination) Help() string {
+	return ""
+}
+
 func (d Destination) Display() string {
 	x, y := d.nodes[0].(*node.HoleEmitter).Destination()
 	amountX, amountY := d.nodes[0].(*node.HoleEmitter).DestinationAmount()
diff --git a/ui/param/direction.go b/ui/param/direction.go
@@ -18,6 +18,10 @@ func (d Direction) Name() string {
 	return "direction"
 }
 
+func (d Direction) Help() string {
+	return ""
+}
+
 func (d Direction) Display() string {
 	return d.nodes[0].Direction().Symbol()
 }
diff --git a/ui/param/key.go b/ui/param/key.go
@@ -30,6 +30,10 @@ func (k *Key) Name() string {
 	return "key"
 }
 
+func (k *Key) Help() string {
+	return ""
+}
+
 func (k *Key) Display() string {
 	if k.mode == KeyModeSilent {
 		return "⨯"
diff --git a/ui/param/length.go b/ui/param/length.go
@@ -21,6 +21,10 @@ func (l Length) Name() string {
 	return "len"
 }
 
+func (l Length) Help() string {
+	return ""
+}
+
 func (l Length) Display() string {
 	length := int(l.nodes[0].(music.Audible).Note().Length.Value())
 	pulsesPerStep, stepsPerQuarterNote := l.nodes[0].(music.Audible).Note().ClockDivision()
diff --git a/ui/param/offset.go b/ui/param/offset.go
@@ -18,6 +18,10 @@ func (o Offset) Name() string {
 	return "off"
 }
 
+func (o Offset) Help() string {
+	return ""
+}
+
 func (o Offset) Display() string {
 	if o.nodes[0].(*node.EuclidEmitter).Offset.RandomAmount() != 0 {
 		return util.Normalize(
diff --git a/ui/param/param.go b/ui/param/param.go
@@ -14,6 +14,7 @@ const (
 
 type Param interface {
 	Name() string
+	Help() string
 	Value() int
 	AltValue() int
 	Display() string
diff --git a/ui/param/probability.go b/ui/param/probability.go
@@ -20,6 +20,10 @@ func (p Probability) Name() string {
 	return "prb"
 }
 
+func (p Probability) Help() string {
+	return ""
+}
+
 func (p Probability) Display() string {
 	return fmt.Sprintf("%d", p.Value())
 }
diff --git a/ui/param/root.go b/ui/param/root.go
@@ -17,6 +17,10 @@ func (r Root) Name() string {
 	return "root"
 }
 
+func (r Root) Help() string {
+	return ""
+}
+
 func (r Root) Display() string {
 	return r.grid.Key.Name()
 }
diff --git a/ui/param/root_cmd.go b/ui/param/root_cmd.go
@@ -19,6 +19,10 @@ func (r RootCmd) Name() string {
 	return "root"
 }
 
+func (r RootCmd) Help() string {
+	return ""
+}
+
 func (r RootCmd) Display() string {
 	if !r.nodes[0].(music.Audible).Note().MetaCommands[rootCmdIndex].Active() {
 		return "⨯"
diff --git a/ui/param/scale.go b/ui/param/scale.go
@@ -14,6 +14,10 @@ func (s Scale) Name() string {
 	return "scale"
 }
 
+func (s Scale) Help() string {
+	return ""
+}
+
 func (s Scale) Display() string {
 	return s.grid.Scale.Name()
 }
diff --git a/ui/param/scale_cmd.go b/ui/param/scale_cmd.go
@@ -19,6 +19,10 @@ func (s ScaleCmd) Name() string {
 	return "scale"
 }
 
+func (s ScaleCmd) Help() string {
+	return ""
+}
+
 func (s ScaleCmd) Display() string {
 	if !s.nodes[0].(music.Audible).Note().MetaCommands[scaleCmdIndex].Active() {
 		return "⨯"
diff --git a/ui/param/steps.go b/ui/param/steps.go
@@ -18,6 +18,10 @@ func (s Steps) Name() string {
 	return "stp"
 }
 
+func (s Steps) Help() string {
+	return ""
+}
+
 func (s Steps) Display() string {
 	if s.nodes[0].(*node.EuclidEmitter).Steps.RandomAmount() != 0 {
 		return util.Normalize(
diff --git a/ui/param/tempo_cmd.go b/ui/param/tempo_cmd.go
@@ -19,6 +19,10 @@ func (t TempoCmd) Name() string {
 	return "tempo"
 }
 
+func (t TempoCmd) Help() string {
+	return ""
+}
+
 func (t TempoCmd) Display() string {
 	if !t.nodes[0].(music.Audible).Note().MetaCommands[tempoCmdIndex].Active() {
 		return "⨯"
diff --git a/ui/param/threshold.go b/ui/param/threshold.go
@@ -19,6 +19,10 @@ func (t Threshold) Name() string {
 	return "thd"
 }
 
+func (t Threshold) Help() string {
+	return ""
+}
+
 func (t Threshold) Display() string {
 	if t.control().RandomAmount() != 0 {
 		return util.Normalize(
diff --git a/ui/param/transport_send.go b/ui/param/transport_send.go
@@ -12,6 +12,10 @@ func (t TransportSend) Name() string {
 	return "transport"
 }
 
+func (t TransportSend) Help() string {
+	return ""
+}
+
 func (t TransportSend) Display() string {
 	if t.grid.SendTransport {
 		return "on"
diff --git a/ui/param/triggers.go b/ui/param/triggers.go
@@ -21,6 +21,10 @@ func (t Triggers) Name() string {
 	return "trg"
 }
 
+func (t Triggers) Help() string {
+	return ""
+}
+
 func (t Triggers) Display() string {
 	if t.nodes[0].(*node.EuclidEmitter).Triggers.RandomAmount() != 0 {
 		return util.Normalize(
diff --git a/ui/param/velocity.go b/ui/param/velocity.go
@@ -17,6 +17,10 @@ func (v Velocity) Name() string {
 	return "vel"
 }
 
+func (v Velocity) Help() string {
+	return ""
+}
+
 func (v Velocity) Display() string {
 	if v.nodes[0].(music.Audible).Note().Velocity.RandomAmount() != 0 {
 		return util.Normalize(
diff --git a/ui/ui.go b/ui/ui.go
@@ -360,9 +360,15 @@ func (m mainModel) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 func (m mainModel) View() string {
 	help := lipgloss.NewStyle().
 		MarginLeft(2).
-		MarginTop(1).
 		Render(m.help.View(m.keymap))
 
+	paramHelp := ""
+	if m.mode == EDIT {
+		paramHelp = m.help.Styles.ShortDesc.
+			MarginLeft(16).
+			Render(m.activeParam().Help())
+	}
+
 	if m.help.ShowAll {
 		return lipgloss.JoinVertical(
 			lipgloss.Left,
@@ -379,6 +385,7 @@ func (m mainModel) View() string {
 	return lipgloss.JoinVertical(
 		lipgloss.Left,
 		m.renderGrid(),
+		paramHelp,
 		help,
 	)
 }

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,10 @@ func (d DefaultDevice) Name() string {`
`12`	`12`	`return "device"`
`13`	`13`	`}`
`14`	`14`
	`15`	`+func (d DefaultDevice) Help() string {`
	`16`	`+ return ""`
	`17`	`+}`
	`18`	`+`
`15`	`19`	`func (d DefaultDevice) Display() string {`
`16`	`20`	`return d.grid.MidiDevice()`
`17`	`21`	`}`
Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,10 @@ func (d Direction) Name() string {`
`18`	`18`	`return "direction"`
`19`	`19`	`}`
`20`	`20`
	`21`	`+func (d Direction) Help() string {`
	`22`	`+ return ""`
	`23`	`+}`
	`24`	`+`
`21`	`25`	`func (d Direction) Display() string {`
`22`	`26`	`return d.nodes[0].Direction().Symbol()`
`23`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,10 @@ func (p Probability) Name() string {`
`20`	`20`	`return "prb"`
`21`	`21`	`}`
`22`	`22`
	`23`	`+func (p Probability) Help() string {`
	`24`	`+ return ""`
	`25`	`+}`
	`26`	`+`
`23`	`27`	`func (p Probability) Display() string {`
`24`	`28`	`return fmt.Sprintf("%d", p.Value())`
`25`	`29`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,10 @@ func (r Root) Name() string {`
`17`	`17`	`return "root"`
`18`	`18`	`}`
`19`	`19`
	`20`	`+func (r Root) Help() string {`
	`21`	`+ return ""`
	`22`	`+}`
	`23`	`+`
`20`	`24`	`func (r Root) Display() string {`
`21`	`25`	`return r.grid.Key.Name()`
`22`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,10 @@ func (s Scale) Name() string {`
`14`	`14`	`return "scale"`
`15`	`15`	`}`
`16`	`16`
	`17`	`+func (s Scale) Help() string {`
	`18`	`+ return ""`
	`19`	`+}`
	`20`	`+`
`17`	`21`	`func (s Scale) Display() string {`
`18`	`22`	`return s.grid.Scale.Name()`
`19`	`23`	`}`