define custom usage handler.

add guard for toggleCmd to prevent unsafe gain changes.

use logrus for control of log levels.

add an input prompt for interactive mode

.gitignore

@@ -19,3 +19,7 @@ config.toml
 
 # Dependency directories (remove the comment below to include it)
 # vendor/
+
+# work files
+go.work
+go.work.sum

CHANGELOG.md

@@ -11,6 +11,19 @@ Before any major/minor/patch bump all unit tests will be run to verify they pass
 
 - [x]
 
+## [2.1.0] - 2024-07-01
+
+### Added
+
+- Added a configurable login timeout in seconds (defaults to 2).
+- Option function added for overriding the type of Voicemeeter GUI runVoicemeeter() will launch.
+- Explanation of Option functions added to README.
+
+### Changed
+
+- runVoicemeeter() now launches x64 GUIs for all kinds if on a 64 bit system.
+  - this can be overridden to force 32 bit GUI using voicemeeter.WithBits(32) Option function
+
 ## [2.0.0] - 2022-10-25
 
 V2 introduces some breaking changes.

README.md

@@ -1,16 +1,14 @@
 [![Go Reference](https://pkg.go.dev/badge/github.com/onyx-and-iris/voicemeeter.svg)](https://pkg.go.dev/github.com/onyx-and-iris/voicemeeter/v2)
 
-# A Go Wrapper for Voicemeeter API
+# A Go Wrapper for the Voicemeeter API
-
-This package offers a Go interface for the Voicemeeter Remote C API.
 
 For an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md)
 
 ## Tested against
 
--   Basic 1.0.8.8
+- Basic 1.1.1.1
--   Banana 2.0.6.8
+- Banana 2.1.1.1
--   Potato 3.0.2.8
+- Potato 3.1.1.1
 
 ## Requirements
 
@@ -67,7 +65,7 @@ func vmConnect() (*voicemeeter.Remote, error) {
 }
 ```
 
-## `voicemeeter.NewRemote(<kindId>, <delay>)`
+## `voicemeeter.NewRemote(<kindId>, <delay>, opts ...Option)`
 
 ### `kindId`
 
@@ -83,6 +81,18 @@ Pass a delay in milliseconds to force the getters to wait for dirty parameters t
 
 Useful if not listening for event updates.
 
+### `voicemeeter.WithTimeout(timeout int)`
+
+Set a login timeout, defaults to 2 seconds. For example to set it to 1s:
+
+`voicemeeter.NewRemote("banana", 20, voicemeeter.WithTimeout(1))`
+
+### `voicemeeter.WithBits(bits int)`
+
+Override the type of Voicemeeter GUI to launch on 64 bit systems. For example, to force 32 bit GUI:
+
+`voicemeeter.NewRemote("banana", 20, voicemeeter.WithBits(32))`
+
 ## `Remote Type`
 
 #### `vm.Strip`
@@ -587,4 +597,4 @@ go test ./...
 
 ### Official Documentation
 
--   [Voicemeeter Remote C API](https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/update-docs/VoicemeeterRemoteAPI.pdf)
+- [Voicemeeter Remote C API](https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/main/VoicemeeterRemoteAPI.pdf)

base.go

@@ -2,8 +2,10 @@ package voicemeeter
 
 import (
 	"bytes"
+	"errors"
 	"fmt"
 	"math"
+	"runtime"
 	"strings"
 	"syscall"
 	"time"
@@ -45,16 +47,29 @@ var (
 // login logs into the API,
 // attempts to launch Voicemeeter if it's not running,
 // initializes dirty parameters.
-func login(kindId string) error {
+func login(kindId string, timeout, bits int) error {
 	res, _, _ := vmLogin.Call()
 	if res == 1 {
-		runVoicemeeter(kindId)
+		runVoicemeeter(kindId, bits)
-		time.Sleep(time.Second)
 	} else if res != 0 {
 		err := fmt.Errorf("VBVMR_Login returned %d", res)
 		return err
 	}
-	log.Info("Logged into Voicemeeter ", kindId)
+
+	var ver_s string
+	start := time.Now()
+	var err error
+	for time.Since(start).Seconds() < float64(timeout) {
+		time.Sleep(time.Duration(100) * time.Millisecond)
+		if ver_s, err = getVersion(); err == nil {
+			log.Infof("Logged into Voicemeeter %s v%s", kindMap[kindId], ver_s)
+			log.Debugf("Log in time: %.2f", time.Since(start).Seconds())
+			break
+		}
+	}
+	if err != nil {
+		return errors.New("timeout logging into the API")
+	}
 	clear()
 	return nil
 }
@@ -68,18 +83,22 @@ func logout(kindId string) error {
 		err := fmt.Errorf("VBVMR_Logout returned %d", int32(res))
 		return err
 	}
-	log.Info("Logged out of Voicemeeter ", kindId)
+	log.Infof("Logged out of Voicemeeter %s", kindMap[kindId])
 	return nil
 }
 
 // runVoicemeeter attempts to launch a Voicemeeter GUI of a kind.
-func runVoicemeeter(kindId string) error {
+func runVoicemeeter(kindId string, bits int) error {
 	vals := map[string]uint64{
 		"basic":  1,
 		"banana": 2,
 		"potato": 3,
 	}
-	res, _, _ := vmRunvm.Call(uintptr(vals[kindId]))
+	val := vals[kindId]
+	if strings.Contains(runtime.GOARCH, "64") && bits == 64 {
+		val += 3
+	}
+	res, _, _ := vmRunvm.Call(uintptr(val))
 	if int32(res) != 0 {
 		err := fmt.Errorf("VBVMR_RunVoicemeeter returned %d", int32(res))
 		return err
@@ -93,6 +112,7 @@ func getVersion() (string, error) {
 	res, _, _ := vmGetvmVersion.Call(uintptr(unsafe.Pointer(&ver)))
 	if int32(res) != 0 {
 		err := fmt.Errorf("VBVMR_GetVoicemeeterVersion returned %d", int32(res))
+		log.Error(err.Error())
 		return "", err
 	}
 	v1 := (ver & 0xFF000000) >> 24

examples/hotkeys/go.mod

@@ -1,4 +1,4 @@
-module main
+module hotkeys
 
 go 1.19
 

examples/obs/go.mod

@@ -1,4 +1,4 @@
-module main
+module obs
 
 go 1.18
 

examples/vm-cli/README.md

@@ -1,6 +1,6 @@
 ## About
 
-A simple voicemeeter-cli program. Offers ability to toggle, get and set parameters.
+A Voicemeeter CLI, offers ability to toggle, get and set parameters.
 
 ## Install
 
@@ -8,28 +8,32 @@ First build and install it with `go install` (skip this step if using binary fro
 
 ## Use
 
-Toggle with `!` prefix, get by excluding `=` and set by including `=`. Mix and match arguments.
+Commands that begin with `!` will toggle a parameter, commands that contain `=` will set a parameter, all other commands will get a value.
 
 You may pass the following optional flags:
 
--   -v: (-verbose) to toggle console output.
+- -h: Print the help message
--   -i: (-interactive) to toggle interactive mode.
+- -i: Enable interactive mode
--   -k: (-kind) to set the kind of Voicemeeter. Defaults to banana.
+- -k: The kind of Voicemeeter GUI to launch, defaults to Banana
--   -d: (-delay) to set a delay on the getters. Defaults to 20ms.
+- -l: Log level (0 up to 6), defaults to 3, Warn Level
+- -d: Set the delay between commands, defaults to 20ms
+- -v: Enable extra console output (toggle and set messages).
 
 for example:
 
-`vm-cli.exe -v -k=potato -d=25 strip[0].mute=0 strip[0].mute !strip[0].mute strip[0].mute bus[0].gain=-8.8 command.lock=1`
+`vm-cli.exe -v -l=4 -k=potato strip[0].mute=0 strip[0].mute !strip[0].mute strip[0].mute bus[0].gain=-8.8 command.lock=1`
 
 Expected output:
 
 ```
-Running command strip[0].mute=0
+time="<timestamp>" level=info msg="Logged into Voicemeeter Potato v3.1.1.1"
-Value of strip[0].mute is: 0
+Setting strip[0].mute=0
+strip[0].mute: 0.00
 Toggling strip[0].mute
-Value of strip[0].mute is: 1
+strip[0].mute: 1.00
-Running command bus[0].gain=-8.8
+Setting bus[0].gain=-8.8
-Running command command.lock=1
+Setting command.lock=1
+time="<timestamp>" level=info msg="Logged out of Voicemeeter Potato"
 ```
 
-If running in interactive mode enter `q`, `quit` or `<Enter>` to exit.
+If running in interactive mode enter `Q`, to exit.

examples/vm-cli/main.go

@@ -4,18 +4,28 @@ import (
 	"bufio"
 	"flag"
 	"fmt"
-	"log"
 	"os"
 	"strings"
 
+	log "github.com/sirupsen/logrus"
+
 	"github.com/onyx-and-iris/voicemeeter/v2"
 )
 
-type (
+const (
-	verbosePrinter struct {
+	FLOAT = iota
+	STRING
+)
+
+type result struct {
+	kind        int
+	stringParam string
+	floatParam  float64
+}
+
+type verbosePrinter struct {
 	verbose bool
 }
-)
 
 func newVerbosePrinter() *verbosePrinter {
 	return &verbosePrinter{}
@@ -23,7 +33,7 @@ func newVerbosePrinter() *verbosePrinter {
 
 func (v *verbosePrinter) printf(format string, a ...interface{}) {
 	if v.verbose {
-		fmt.Printf(format+"\n", a...)
+		fmt.Printf(format, a...)
 	}
 }
 
@@ -40,28 +50,68 @@ func main() {
 		kind        string
 		delay       int
 		interactive bool
+		loglevel    int
+		help        bool
 	)
 
+	flag.Usage = usage
+
+	flag.BoolVar(&help, "help", false, "print the help message")
+	flag.BoolVar(&help, "h", false, "print the help message (shorthand)")
 	flag.StringVar(&kind, "kind", "banana", "kind of voicemeeter")
 	flag.StringVar(&kind, "k", "banana", "kind of voicemeeter (shorthand)")
 	flag.IntVar(&delay, "delay", 20, "delay between commands")
 	flag.IntVar(&delay, "d", 20, "delay between commands (shorthand)")
-	flag.BoolVar(&vPrinter.verbose, "verbose", false, "toggle console output")
-	flag.BoolVar(&vPrinter.verbose, "v", false, "toggle console output (shorthand)")
 	flag.BoolVar(&interactive, "interactive", false, "toggle interactive mode")
 	flag.BoolVar(&interactive, "i", false, "toggle interactive mode (shorthand)")
+	flag.IntVar(&loglevel, "loglevel", int(log.WarnLevel), "set the log level")
+	flag.IntVar(&loglevel, "l", int(log.WarnLevel), "set the log level (shorthand)")
+	flag.BoolVar(&vPrinter.verbose, "verbose", false, "enable extra console output (toggle and set messages)")
+	flag.BoolVar(&vPrinter.verbose, "v", false, "enable extra console output (toggle and set messages) (shorthand)")
 	flag.Parse()
 
+	if help {
+		flag.Usage()
+		return
+	}
+
+	if loglevel >= int(log.PanicLevel) && loglevel <= int(log.TraceLevel) {
+		log.SetLevel(log.Level(loglevel))
+	}
+
 	vm, err := vmConnect(kind, delay)
 	if err != nil {
 		log.Fatal(err)
 	}
 	defer vm.Logout()
 
-	err = runCommands(vm, interactive)
+	if interactive {
-	if err != nil {
+		interactiveMode(vm)
-		fmt.Println(err)
+		return
 	}
+
+	args := flag.Args()
+	if len(args) == 0 {
+		flag.Usage()
+		return
+	}
+
+	for _, arg := range args {
+		if err := parse(vm, arg); err != nil {
+			log.Error(err.Error())
+		}
+	}
+}
+
+func usage() {
+	fmt.Println("usage: ./vm-cli.exe [-h] [-i] [-k] [-l] [-d] [-v]\n" +
+		"Where:\n" +
+		"\th: Print the help message\n" +
+		"\ti: Enable interactive mode\n" +
+		"\tk: The kind of Voicemeeter GUI to launch, defaults to Banana\n" +
+		"\tl: Log level 0 up to 6, (defaults to 3, Warn Level)\n" +
+		"\td: Set the delay between commands (defaults to 20ms)\n" +
+		"\tv: Enable extra console output (toggle and set messages).")
 }
 
 func vmConnect(kind string, delay int) (*voicemeeter.Remote, error) {
@@ -78,38 +128,23 @@ func vmConnect(kind string, delay int) (*voicemeeter.Remote, error) {
 	return vm, nil
 }
 
-func runCommands(vm *voicemeeter.Remote, interactive bool) error {
-	if interactive {
-		return interactiveMode(vm)
-	}
-	args := flag.Args()
-	if len(args) == 0 {
-		err := fmt.Errorf("must provide some commands to run")
-		return err
-	}
-	for _, arg := range args {
-		err := parse(vm, arg)
-		if err != nil {
-			vPrinter.printf(err.Error())
-		}
-	}
-	return nil
-}
-
 func interactiveMode(vm *voicemeeter.Remote) error {
-	vPrinter.printf("running in interactive mode... waiting for input")
+	fmt.Println("Interactive mode enabled. Enter 'Q' to exit.")
+
 	scanner := bufio.NewScanner(os.Stdin)
+	fmt.Printf(">> ")
 	for scanner.Scan() {
 		input := scanner.Text()
-		if input == "q" || input == "quit" || input == "" {
+		if strings.ToUpper(input) == "Q" {
-			return nil
+			break
 		}
+
 		for _, cmd := range strings.Split(input, " ") {
-			err := parse(vm, cmd)
+			if err := parse(vm, cmd); err != nil {
-			if err != nil {
+				log.Error(err.Error())
-				vPrinter.printf(err.Error())
 			}
 		}
+		fmt.Printf(">> ")
 	}
 	if scanner.Err() != nil {
 		return scanner.Err()
@@ -119,58 +154,60 @@ func interactiveMode(vm *voicemeeter.Remote) error {
 
 func parse(vm *voicemeeter.Remote, cmd string) error {
 	if cmd[0] == '!' {
-		err := toggleCmd(vm, cmd[1:])
+		if err := toggleCmd(vm, cmd[1:]); err != nil {
-		if err != nil {
+			return err
+		}
+	} else if strings.Contains(cmd, "=") {
+		if err := setCmd(vm, cmd); err != nil {
 			return err
 		}
 	} else {
-		if strings.Contains(cmd, "=") {
+		r := result{kind: FLOAT}
-			err := setCmd(vm, cmd)
+		if err := getCmd(vm, cmd, &r); err != nil {
-			if err != nil {
-				return err
-			}
-		} else {
-			err := getCmd(vm, cmd)
-			if err != nil {
 			return err
 		}
+		switch r.kind {
+		case FLOAT:
+			fmt.Printf("%s: %.2f\n", cmd, r.floatParam)
+		case STRING:
+			fmt.Printf("%s: %s\n", cmd, r.stringParam)
 		}
 	}
 	return nil
 }
 
 func toggleCmd(vm *voicemeeter.Remote, cmd string) error {
-	val, err := vm.GetFloat(cmd)
+	r := result{kind: FLOAT}
-	if err != nil {
+	if err := getCmd(vm, cmd, &r); err != nil {
-		err = fmt.Errorf("unable to toggle %s", cmd)
 		return err
 	}
-	vm.SetFloat(cmd, 1-val)
+	if r.kind == FLOAT && (r.floatParam == 0 || r.floatParam == 1) {
-	vPrinter.printf("Toggling %s", cmd)
+		vPrinter.printf("Toggling %s\n", cmd)
+		vm.SetFloat(cmd, 1-r.floatParam)
+	} else {
+		log.Warnf("%s does not appear to be a boolean parameter", cmd)
+	}
 	return nil
 }
 
 func setCmd(vm *voicemeeter.Remote, cmd string) error {
-	vPrinter.printf("Running command %s", cmd)
+	if err := vm.SendText(cmd); err != nil {
-	err := vm.SendText(cmd)
-	if err != nil {
 		err = fmt.Errorf("unable to set %s", cmd)
 		return err
 	}
+	vPrinter.printf("Setting %s\n", cmd)
 	return nil
 }
 
-func getCmd(vm *voicemeeter.Remote, cmd string) error {
+func getCmd(vm *voicemeeter.Remote, cmd string, r *result) error {
-	valF, err := vm.GetFloat(cmd)
+	if val, err := vm.GetFloat(cmd); err == nil {
-	if err != nil {
+		r.floatParam = val
-		valS, err := vm.GetString(cmd)
+	} else if val, err := vm.GetString(cmd); err == nil {
-		if err != nil {
+		r.kind = STRING
-			err = fmt.Errorf("unable to get %s", cmd)
+		r.stringParam = val
-			return err
-		}
-		fmt.Printf("Value of %s is: %s", cmd, valS)
 	} else {
-		fmt.Printf("Value of %s is: %v", cmd, valF)
+		err := fmt.Errorf("unknown parameter '%s'", cmd)
+		return err
 	}
 	return nil
 }

remote.go

@@ -21,6 +21,8 @@ type Remote struct {
 	Midi     *midi_t
 
 	pooler  *pooler
+	timeout int
+	bits    int
 }
 
 // String implements the fmt.stringer interface
@@ -31,7 +33,7 @@ func (r *Remote) String() string {
 // Login logs into the API
 // then it intializes the pooler
 func (r *Remote) Login() error {
-	err := login(r.Kind.Name)
+	err := login(r.Kind.Name, r.timeout, r.bits)
 	if err != nil {
 		return err
 	}
@@ -57,12 +59,10 @@ func (r *Remote) InitPooler() {
 
 // Run launches the Voicemeeter GUI for a kind.
 func (r *Remote) Run(kindId string) error {
-	err := runVoicemeeter(kindId)
+	err := runVoicemeeter(kindId, r.bits)
 	if err != nil {
 		return err
 	}
-	time.Sleep(time.Second)
-	clear()
 	return nil
 }
 
@@ -173,6 +173,7 @@ type remoteBuilder interface {
 	makeDevice() remoteBuilder
 	makeRecorder() remoteBuilder
 	makeMidi() remoteBuilder
+	setDefaults() remoteBuilder
 	Build() remoteBuilder
 	Get() *Remote
 }
@@ -212,7 +213,7 @@ func (b *genericBuilder) setKind() remoteBuilder {
 // makeStrip makes a strip slice and assigns it to remote.Strip
 // []iStrip comprises of both physical and virtual strip types
 func (b *genericBuilder) makeStrip() remoteBuilder {
-	log.Info("building strip")
+	log.Debug("building strip")
 	strip := make([]iStrip, b.k.NumStrip())
 	for i := 0; i < b.k.NumStrip(); i++ {
 		if i < b.k.PhysIn {
@@ -228,7 +229,7 @@ func (b *genericBuilder) makeStrip() remoteBuilder {
 // makeBus makes a bus slice and assigns it to remote.Bus
 // []t_bus comprises of both physical and virtual bus types
 func (b *genericBuilder) makeBus() remoteBuilder {
-	log.Info("building bus")
+	log.Debug("building bus")
 	bus := make([]iBus, b.k.NumBus())
 	for i := 0; i < b.k.NumBus(); i++ {
 		if i < b.k.PhysOut {
@@ -243,7 +244,7 @@ func (b *genericBuilder) makeBus() remoteBuilder {
 
 // makeButton makes a button slice and assigns it to remote.Button
 func (b *genericBuilder) makeButton() remoteBuilder {
-	log.Info("building button")
+	log.Debug("building button")
 	button := make([]button, 80)
 	for i := 0; i < 80; i++ {
 		button[i] = newButton(i)
@@ -254,39 +255,46 @@ func (b *genericBuilder) makeButton() remoteBuilder {
 
 // makeCommand makes a command type and assigns it to remote.Command
 func (b *genericBuilder) makeCommand() remoteBuilder {
-	log.Info("building command")
+	log.Debug("building command")
 	b.r.Command = newCommand()
 	return b
 }
 
 // makeVban makes a vban type and assigns it to remote.Vban
 func (b *genericBuilder) makeVban() remoteBuilder {
-	log.Info("building vban")
+	log.Debug("building vban")
 	b.r.Vban = newVban(b.k)
 	return b
 }
 
 // makeDevice makes a device type and assigns it to remote.Device
 func (b *genericBuilder) makeDevice() remoteBuilder {
-	log.Info("building device")
+	log.Debug("building device")
 	b.r.Device = newDevice()
 	return b
 }
 
 // makeRecorder makes a recorder type and assigns it to remote.Recorder
 func (b *genericBuilder) makeRecorder() remoteBuilder {
-	log.Info("building recorder")
+	log.Debug("building recorder")
 	b.r.Recorder = newRecorder()
 	return b
 }
 
 // makeMidi makes a midi type and assigns it to remote.Midi
 func (b *genericBuilder) makeMidi() remoteBuilder {
-	log.Info("building midi")
+	log.Debug("building midi")
 	b.r.Midi = newMidi()
 	return b
 }
 
+// setDefaults sets defaults for optional members
+func (b *genericBuilder) setDefaults() remoteBuilder {
+	b.r.bits = 64
+	b.r.timeout = 2
+	return b
+}
+
 // Get returns a fully constructed remote type for a kind
 func (b *genericBuilder) Get() *Remote {
 	return &b.r
@@ -306,7 +314,8 @@ func (basb *genericBuilder) Build() remoteBuilder {
 		makeCommand().
 		makeVban().
 		makeDevice().
-		makeMidi()
+		makeMidi().
+		setDefaults()
 }
 
 // bananaBuilder represents a builder specific to banana type
@@ -324,7 +333,8 @@ func (banb *bananaBuilder) Build() remoteBuilder {
 		makeVban().
 		makeDevice().
 		makeRecorder().
-		makeMidi()
+		makeMidi().
+		setDefaults()
 }
 
 // potatoBuilder represents a builder specific to potato type
@@ -342,7 +352,8 @@ func (potb *potatoBuilder) Build() remoteBuilder {
 		makeVban().
 		makeDevice().
 		makeRecorder().
-		makeMidi()
+		makeMidi().
+		setDefaults()
 }
 
 var (
@@ -350,6 +361,22 @@ var (
 	vmdelay int
 )
 
+type Option func(*Remote)
+
+func WithTimeout(timeout int) Option {
+	return func(r *Remote) {
+		r.timeout = timeout
+	}
+}
+
+func WithBits(bits int) Option {
+	return func(r *Remote) {
+		if bits == 32 || bits == 64 {
+			r.bits = bits
+		}
+	}
+}
+
 func init() {
 	log.SetOutput(os.Stdout)
 	log.SetLevel(log.WarnLevel)
@@ -357,7 +384,7 @@ func init() {
 
 // NewRemote returns a Remote type for a kind
 // this is the interface entry point
-func NewRemote(kindId string, delay int) (*Remote, error) {
+func NewRemote(kindId string, delay int, opts ...Option) (*Remote, error) {
 	kind, ok := kindMap[kindId]
 	if !ok {
 		err := fmt.Errorf("unknown Voicemeeter kind '%s'", kindId)
@@ -380,5 +407,11 @@ func NewRemote(kindId string, delay int) (*Remote, error) {
 		director.SetBuilder(&potatoBuilder{genericBuilder{kind, Remote{}}})
 	}
 	director.Construct()
-	return director.Get(), nil
+	r := director.Get()
+
+	for _, opt := range opts {
+		opt(r)
+	}
+
+	return r, nil
 }