fix deregister in observer example

minor version bump

CHANGELOG.md

@@ -11,6 +11,22 @@ Before any major/minor/patch bump all unit tests will be run to verify they pass
 
 -   [x]
 
+## [1.3.0] - 2022-08-22
+
+### Added
+
+-   midi type, supports midi devices
+-   midi updates added to the pooler
+-   event type, supports toggling event updates through EventAdd() and EventRemove() methods.
+-   Forwarder methods for get/set float/string parameters added to Remote type
+-   Midi, Events sections added to README.
+
+### Changed
+
+-   macrobutton updates moved into its own goroutine
+-   observer example updated to include midi updates
+-   level updates are now disabled by default, should be enabled explicitly
+
 ## [1.2.0] - 2022-07-10
 
 ### Added

README.md

@@ -8,9 +8,9 @@ For an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md)
 
 ## Tested against
 
--   Basic 1.0.8.2
+-   Basic 1.0.8.4
--   Banana 2.0.6.2
+-   Banana 2.0.6.4
--   Potato 3.0.2.2
+-   Potato 3.0.2.4
 
 ## Requirements
 
@@ -98,6 +98,10 @@ pointer to device type, represents physical input/output hardware devices
 
 pointer to recorder type, represents the recorder
 
+#### `vm.Midi`
+
+pointer to midi type, represents a connected midi device
+
 #### `vm.Type()`
 
 returns the type of Voicemeeter as a string
@@ -106,6 +110,22 @@ returns the type of Voicemeeter as a string
 
 returns the version of Voicemeeter as a string
 
+#### `vm.GetFloat(<param>)`
+
+gets a float parameter value
+
+#### `vm.SetFloat(<param>, <value>)`
+
+sets a float parameter value eg. vm.SetFloat("strip[0].mute", 1)
+
+#### `vm.GetString(<param>)`
+
+gets a string parameter value
+
+#### `vm.SetString(<param>, <value>)`
+
+sets a string parameter value eg. vm.SetString("strip[0].label", "podmic")
+
 #### `vm.SendText(<script>)`
 
 sets many parameters in script format eg. ("Strip[0].Mute=1;Bus[3].Gain=3.6")
@@ -118,13 +138,21 @@ register an object as an observer
 
 deregister an object as an observer
 
+#### `vm.EventAdd(<event>)`
+
+adds an event to the pooler eg. vm.EventAdd("ldirty")
+
+#### `vm.EventRemove(<event>)`
+
+removes an event to the pooler eg. vm.EventRemove("pdirty")
+
 #### `vm.Pdirty()`
 
 returns True iff a GUI parameter has changed
 
 #### `vm.Mdirty()`
 
-returns True iff a macrobutton paramter has changed
+returns True iff a macrobutton parameter has changed
 
 ## `Available commands`
 
@@ -348,8 +376,8 @@ vm.Vban.OutStream[3].SetBit(24)
 
 The following methods are available
 
--   `Ins`
+-   `Ins()`
--   `Outs`
+-   `Outs()`
 -   `Input(val int)`
 -   `Output(val int)`
 
@@ -386,6 +414,38 @@ vm.Recorder.Loop(true)
 vm.Recorder.SetB2(false)
 ```
 
+### Midi
+
+The following methods are available
+
+-   `Channel()` returns the current midi channel
+-   `Current()` returns the most recently pressed midi button
+-   `Get(<button>)` returns the value in cache for the midi button
+
+example:
+
+```go
+var current = vm.Midi.Current()
+var val = vm.Midi.Get(current)
+```
+
+### Events
+
+By default level updates are disabled. Any event may be enabled or disabled. The following events exist:
+
+-   `pdirty` parameter updates
+-   `mdirty` macrobutton updates
+-   `midi` midi updates
+-   `ldirty` level updates
+
+example:
+
+```go
+vm.EventAdd("ldirty")
+
+vm.EventRemove("pdirty")
+```
+
 ### Run tests
 
 To run all tests:

base.go

@@ -37,6 +37,8 @@ var (
 	vmMdirty         = mod.NewProc("VBVMR_MacroButton_IsDirty")
 	vmGetMacroStatus = mod.NewProc("VBVMR_MacroButton_GetStatus")
 	vmSetMacroStatus = mod.NewProc("VBVMR_MacroButton_SetStatus")
+
+	vmGetMidiMessage = mod.NewProc("VBVMR_GetMidiMessage")
 )
 
 // login logs into the API,
@@ -315,3 +317,34 @@ func getLevel(type_, i int) float32 {
 	}
 	return val
 }
+
+// getMidiMessage gets midi channel, pitch and velocity for a single midi input
+func getMidiMessage() bool {
+	var midi = newMidi()
+	var b1 [1024]byte
+	res, _, _ := vmGetMidiMessage.Call(
+		uintptr(unsafe.Pointer(&b1[0])),
+		uintptr(1024),
+	)
+	if int(res) < 0 {
+		err := fmt.Errorf("VBVMR_GetMidiMessage returned %d", res)
+		fmt.Println(err)
+		os.Exit(1)
+	}
+	msg := bytes.Trim(b1[:], "\x00")
+	if len(msg) > 0 {
+		for i := 0; i < len(msg)%3; i++ {
+			msg = append(msg, 0)
+		}
+
+		for i := 0; i < len(msg); i += 3 {
+			var ch = int(msg[i])
+			var pitch = int(msg[i+1])
+			var vel = int(msg[i+2])
+			midi.channel = ch
+			midi.current = pitch
+			midi.cache[pitch] = vel
+		}
+	}
+	return len(msg) > 0
+}

examples/observer/observer.go

@@ -2,7 +2,6 @@ package main
 
 import (
 	"fmt"
-	"strings"
 	"time"
 
 	"github.com/onyx-and-iris/voicemeeter-api-go"
@@ -12,14 +11,27 @@ type observer struct {
 	vm *voicemeeter.Remote
 }
 
+func (o observer) Register() {
+	o.vm.Register(o)
+}
+
+func (o observer) Deregister() {
+	o.vm.Deregister(o)
+}
+
 func (o observer) OnUpdate(subject string) {
-	if strings.Compare(subject, "pdirty") == 0 {
+	if subject == "pdirty" {
 		fmt.Println("pdirty!")
 	}
-	if strings.Compare(subject, "mdirty") == 0 {
+	if subject == "mdirty" {
 		fmt.Println("mdirty!")
 	}
-	if strings.Compare(subject, "ldirty") == 0 {
+	if subject == "midi" {
+		var current = o.vm.Midi.Current()
+		var val = o.vm.Midi.Get(current)
+		fmt.Printf("Value of midi button %d: %d\n", current, val)
+	}
+	if subject == "ldirty" {
 		fmt.Printf("%v %v %v %v %v %v %v %v\n",
 			o.vm.Bus[0].Levels().IsDirty(),
 			o.vm.Bus[1].Levels().IsDirty(),
@@ -36,11 +48,13 @@ func (o observer) OnUpdate(subject string) {
 func main() {
 	vm := voicemeeter.NewRemote("potato")
 	vm.Login()
+	// enable level updates (disabled by default)
+	vm.EventAdd("ldirty")
 
 	o := observer{vm}
-	vm.Register(o)
+	o.Register()
 	time.Sleep(30 * time.Second)
-	vm.Deregister(o)
+	o.Deregister()
 
 	vm.Logout()
 }

helper_test.go

@@ -0,0 +1,24 @@
+package voicemeeter
+
+import (
+	"os"
+	"testing"
+	"time"
+)
+
+var (
+	vm = NewRemote("potato")
+)
+
+func TestMain(m *testing.M) {
+	vm.Login()
+	code := m.Run()
+	vm.Logout()
+	os.Exit(code)
+}
+
+func sync() {
+	time.Sleep(30 * time.Millisecond)
+	for vm.Pdirty() || vm.Mdirty() {
+	}
+}

midi.go

@@ -0,0 +1,28 @@
+package voicemeeter
+
+var midi *midi_t
+
+type midi_t struct {
+	channel int
+	current int
+	cache   map[int]int
+}
+
+func newMidi() *midi_t {
+	if midi == nil {
+		midi = &midi_t{0, 0, map[int]int{}}
+	}
+	return midi
+}
+
+func (m *midi_t) Channel() int {
+	return m.channel
+}
+
+func (m *midi_t) Current() int {
+	return m.current
+}
+
+func (m *midi_t) Get(key int) int {
+	return m.cache[key]
+}

publisher.go

@@ -40,41 +40,97 @@ func (p *publisher) notify(subject string) {
 	}
 }
 
+type event struct {
+	pdirty bool
+	mdirty bool
+	midi   bool
+	ldirty bool
+}
+
+func newEvent() *event {
+	return &event{true, true, true, false}
+}
+
+func (e *event) Add(ev string) {
+	switch ev {
+	case "pdirty":
+		e.pdirty = true
+	case "mdirty":
+		e.mdirty = true
+	case "midi":
+		e.midi = true
+	case "ldirty":
+		e.ldirty = true
+	}
+}
+
+func (e *event) Remove(ev string) {
+	switch ev {
+	case "pdirty":
+		e.pdirty = false
+	case "mdirty":
+		e.mdirty = false
+	case "midi":
+		e.midi = false
+	case "ldirty":
+		e.ldirty = false
+	}
+}
+
 // pooler continuously polls the dirty paramters
 // it is expected to be run in a goroutine
 type pooler struct {
-	k   *kind
+	k     *kind
-	run bool
+	run   bool
+	event *event
 	publisher
 }
 
 func newPooler(k *kind) *pooler {
 	p := &pooler{
-		k:   k,
+		k:     k,
-		run: true,
+		run:   true,
+		event: newEvent(),
 	}
-	go p.runner()
+	go p.parameters()
+	go p.macrobuttons()
+	go p.midi()
 	go p.levels()
 	return p
 }
 
-func (p *pooler) runner() {
+func (p *pooler) parameters() {
 	for p.run {
-		if pdirty() {
+		if p.event.pdirty && pdirty() {
 			p.notify("pdirty")
 		}
-		if mdirty() {
+		time.Sleep(33 * time.Millisecond)
+	}
+}
+
+func (p *pooler) macrobuttons() {
+	for p.run {
+		if p.event.mdirty && mdirty() {
 			p.notify("mdirty")
 		}
 		time.Sleep(33 * time.Millisecond)
 	}
 }
 
+func (p *pooler) midi() {
+	for p.run {
+		if getMidiMessage() {
+			p.notify("midi")
+		}
+		time.Sleep(33 * time.Millisecond)
+	}
+}
+
 func (p *pooler) levels() {
 	_levelCache = newLevelCache(p.k)
 
 	for p.run {
-		if ldirty(p.k) {
+		if p.event.ldirty && ldirty(p.k) {
 			update(_levelCache.stripLevels, _levelCache.stripLevelsBuff, (2*p.k.PhysIn)+(8*p.k.VirtIn))
 			update(_levelCache.busLevels, _levelCache.busLevelsBuff, 8*p.k.NumBus())
 			p.notify("ldirty")

remote.go

@@ -15,6 +15,7 @@ type Remote struct {
 	Vban     *vban
 	Device   *device
 	Recorder *recorder
+	Midi     *midi_t
 
 	pooler *pooler
 }
@@ -58,6 +59,26 @@ func (r *Remote) Mdirty() bool {
 	return mdirty()
 }
 
+// Gets a float parameter value
+func (r *Remote) GetFloat(name string) float64 {
+	return getParameterFloat(name)
+}
+
+// Sets a float paramter value
+func (r *Remote) SetFloat(name string, value float32) {
+	setParameterFloat(name, value)
+}
+
+// Gets a string parameter value
+func (r *Remote) GetString(name string) string {
+	return getParameterString(name)
+}
+
+// Sets a string paramter value
+func (r *Remote) SetString(name, value string) {
+	setParameterString(name, value)
+}
+
 // SendText sets multiple parameters by script
 func (r *Remote) SendText(script string) {
 	setParametersMulti(script)
@@ -73,6 +94,16 @@ func (r *Remote) Deregister(o observer) {
 	r.pooler.Deregister(o)
 }
 
+// EventAdd adds an event to the Pooler
+func (r *Remote) EventAdd(event string) {
+	r.pooler.event.Add(event)
+}
+
+// EventRemove removes an event from the Pooler
+func (r *Remote) EventRemove(event string) {
+	r.pooler.event.Remove(event)
+}
+
 // remoteBuilder defines the interface builder types must satisfy
 type remoteBuilder interface {
 	setKind() remoteBuilder
@@ -83,6 +114,7 @@ type remoteBuilder interface {
 	makeVban() remoteBuilder
 	makeDevice() remoteBuilder
 	makeRecorder() remoteBuilder
+	makeMidi() remoteBuilder
 	Build() remoteBuilder
 	Get() *Remote
 }
@@ -190,6 +222,13 @@ func (b *genericBuilder) makeRecorder() remoteBuilder {
 	return b
 }
 
+// makeMidi makes a midi type and assigns it to remote.Midi
+func (b *genericBuilder) makeMidi() remoteBuilder {
+	fmt.Println("building midi")
+	b.r.Midi = newMidi()
+	return b
+}
+
 // Get returns a fully constructed remote type for a kind
 func (b *genericBuilder) Get() *Remote {
 	return &b.r
@@ -202,7 +241,14 @@ type basicBuilder struct {
 
 // Build defines the steps required to build a basic type
 func (basb *genericBuilder) Build() remoteBuilder {
-	return basb.setKind().makeStrip().makeBus().makeButton().makeCommand().makeVban().makeDevice()
+	return basb.setKind().
+		makeStrip().
+		makeBus().
+		makeButton().
+		makeCommand().
+		makeVban().
+		makeDevice().
+		makeMidi()
 }
 
 // bananaBuilder represents a builder specific to banana type
@@ -212,7 +258,15 @@ type bananaBuilder struct {
 
 // Build defines the steps required to build a banana type
 func (banb *bananaBuilder) Build() remoteBuilder {
-	return banb.setKind().makeStrip().makeBus().makeButton().makeCommand().makeVban().makeDevice().makeRecorder()
+	return banb.setKind().
+		makeStrip().
+		makeBus().
+		makeButton().
+		makeCommand().
+		makeVban().
+		makeDevice().
+		makeRecorder().
+		makeMidi()
 }
 
 // potatoBuilder represents a builder specific to potato type
@@ -222,7 +276,15 @@ type potatoBuilder struct {
 
 // Build defines the steps required to build a potato type
 func (potb *potatoBuilder) Build() remoteBuilder {
-	return potb.setKind().makeStrip().makeBus().makeButton().makeCommand().makeVban().makeDevice().makeRecorder()
+	return potb.setKind().
+		makeStrip().
+		makeBus().
+		makeButton().
+		makeCommand().
+		makeVban().
+		makeDevice().
+		makeRecorder().
+		makeMidi()
 }
 
 // NewRemote returns a Remote type for a kind

remote_test.go

@@ -83,3 +83,24 @@ func TestGetPotatoRemote(t *testing.T) {
 		assert.NotNil(t, __rem.Recorder)
 	})
 }
+
+func TestSetAndGetFloatParameter(t *testing.T) {
+	//t.Skip("skipping test")
+	var param = "strip[0].mute"
+	vm.SetFloat(param, 1)
+	sync()
+	t.Run("Should get a float parameter", func(t *testing.T) {
+		assert.Equal(t, float64(1), vm.GetFloat(param))
+	})
+}
+
+func TestSetAndGetStringParameter(t *testing.T) {
+	//t.Skip("skipping test")
+	var param = "strip[0].label"
+	var val = "test0"
+	vm.SetString(param, val)
+	sync()
+	t.Run("Should get a string parameter", func(t *testing.T) {
+		assert.Equal(t, val, vm.GetString(param))
+	})
+}