add -p flag for loading a user configuration file.

add -p explanation to README

README.md

@@ -13,28 +13,32 @@
 ## `Use`
 
 ```powershell
-./vmrcli.exe [-h] [-i] [-k] [-D] <api commands>
+./vmrcli.exe [-h] [-i] [-k] [-D] [-v] [-p] [-m] [-s] <api commands>
 ```
 
 Where:
 
-- `h`: Prints the help dialogue.
+- `h`: Prints the help message.
 - `i`: Enable interactive mode. If set, any api commands passed on the command line will be ignored.
 - `k`: The kind of Voicemeeter (basic, banana or potato). Use this to launch the GUI.
 - `D`: Set log level 0=TRACE, 1=DEBUG, 2=INFO, 3=WARN, 4=ERROR, 5=FATAL
+- `v`: Enable extra console output (toggle, set messages)
+- `p`: Load a user configuration (given the file name or a full path)
+- `m`: Launch the MacroButtons application
+- `s`: Launch the StreamerView application
 
 ## `API Commands`
 
 - Commands starting with `!` will be toggled, use it with boolean parameters.
-- Commands containing `=` will set a value.
+- Commands containing `=` will set a value. (use `+=` and `-=` to increment/decrement)
 - All other commands with get a value.
 
 Examples:
 
-Launch basic GUI, set log level to INFO, Toggle Strip 0 Mute, then print its new value
+Launch basic GUI, set log level to INFO, Toggle Strip 0 Mute, print its new value, then decrease Bus 0 Gain by 3.8
 
 ```powershell
-./vmrcli.exe -kbasic -D2 !strip[0].mute strip[0].mute
+./vmrcli.exe -kbasic -D2 !strip[0].mute strip[0].mute bus[0].gain-=3.8
 ```
 
 Launch banana GUI, set log level to DEBUG, set Strip 0 label to podmic then print Strip 2 label
@@ -74,14 +78,19 @@ Multiple API commands can be in a single line but they should be space separated
 
 Run the included `makefile` with [GNU Make](https://www.gnu.org/software/make/).
 
-By default the log.c module is built with coloured logging enabled. To disable this you can override the `LOG_USE_COLOR` variable, for example:
+The binary in [Releases][releases] is compiled with coloured logging enabled. To disable this you can override the `LOG_USE_COLOR` variable, for example:
 
 `make LOG_USE_COLOR=no`
 
 ## `Official Documentation`
 
-- [Voicemeeter Remote C API](https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/main/VoicemeeterRemoteAPI.pdf)
+- [Voicemeeter Remote C API][remoteapi-docs]
 
 ## `Special Thanks`
 
-- [rxi](https://github.com/rxi) for writing the [log.c](https://github.com/rxi/log.c) package
+- [rxi][rxi-user] for writing the [log.c][log-c] package
+
+[releases]: https://github.com/onyx-and-iris/vmrcli/releases
+[remoteapi-docs]: https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/main/VoicemeeterRemoteAPI.pdf
+[rxi-user]: https://github.com/rxi
+[log-c]: https://github.com/rxi/log.c

example_commands.txt

@@ -1,3 +1,5 @@
 strip[0].mute !strip[0].mute strip[0].mute strip[0].gain strip[0].label=podmic strip[0].label
-strip[1].mute=1 strip[1].mute
+strip[1].mute=1 strip[1].mute strip[1].limit-=8
-bus[0].label bus[0].gain=-8.3
+strip[2].gain-=5 strip[2].comp+=4.8
+bus[0].label
+bus[1].gain-=5.8

include/cdll.h

@@ -1,9 +1,8 @@
 #ifndef __CDLL_H__
 #define __CDLL_H__
 
-#include <windows.h>
 #include "VoicemeeterRemote.h"
 
-long initialize_dll_interfaces(T_VBVMR_INTERFACE *iVMR);
+PT_VMR create_interface();
 
 #endif /*__CDLL_H__*/

include/util.h

@@ -3,7 +3,7 @@
 
 void remove_name_in_path(char *szPath);
 int replace_multiple_space_with_one(char *s, size_t len);
-char *kind_as_string(char *s, enum kind kind, int n);
+char *kind_as_string(char *s, int kind, int n);
 char *version_as_string(char *, long v, int n);
 
 #endif /* __UTIL_H__ */

include/vmr.h

@@ -6,31 +6,34 @@
 
 enum kind
 {
+    UNKNOWN = -1,
     BASIC = 1,
     BANANA,
     POTATO,
     BASICX64,
     BANANAX64,
     POTATOX64,
+    MACROBUTTONS = 11,
+    STREAMERVIEW
 };
 
-long login(T_VBVMR_INTERFACE *vmr, int kind);
+long login(PT_VMR vmr, int kind);
-long logout(T_VBVMR_INTERFACE *vmr);
+long logout(PT_VMR vmr);
-long run_voicemeeter(T_VBVMR_INTERFACE *vmr, int kind);
+long run_voicemeeter(PT_VMR vmr, int kind);
-long type(T_VBVMR_INTERFACE *vmr, long *type);
+long type(PT_VMR vmr, long *type);
-long version(T_VBVMR_INTERFACE *vmr, long *version);
+long version(PT_VMR vmr, long *version);
 
-bool is_pdirty(T_VBVMR_INTERFACE *vmr);
+bool is_pdirty(PT_VMR vmr);
-long get_parameter_float(T_VBVMR_INTERFACE *vmr, char *param, float *f);
+long get_parameter_float(PT_VMR vmr, char *param, float *f);
-long get_parameter_string(T_VBVMR_INTERFACE *vmr, char *param, unsigned short *s);
+long get_parameter_string(PT_VMR vmr, char *param, unsigned short *s);
-long set_parameter_float(T_VBVMR_INTERFACE *vmr, char *param, float val);
+long set_parameter_float(PT_VMR vmr, char *param, float val);
-long set_parameter_string(T_VBVMR_INTERFACE *vmr, char *param, char *s);
+long set_parameter_string(PT_VMR vmr, char *param, char *s);
-long set_parameters(T_VBVMR_INTERFACE *vmr, char *command);
+long set_parameters(PT_VMR vmr, char *command);
 
-bool is_mdirty(T_VBVMR_INTERFACE *vmr);
+bool is_mdirty(PT_VMR vmr);
-long macrobutton_getstatus(T_VBVMR_INTERFACE *vmr, long n, float *val, long mode);
+long macrobutton_getstatus(PT_VMR vmr, long n, float *val, long mode);
-long macrobutton_setstatus(T_VBVMR_INTERFACE *vmr, long n, float val, long mode);
+long macrobutton_setstatus(PT_VMR vmr, long n, float val, long mode);
 
-void clear_dirty(T_VBVMR_INTERFACE *vmr);
+void clear_dirty(PT_VMR vmr);
 
 #endif /* __VMR_H__ */

src/cdll.c

@@ -1,7 +1,151 @@
 #include <stdbool.h>
 #include <stdio.h>
+#include <windows.h>
 #include "cdll.h"
 #include "util.h"
+#include "log.h"
+
+static T_VBVMR_INTERFACE iVMR;
+
+static long initialize_dll_interfaces(PT_VMR vmr);
+static bool registry_get_voicemeeter_folder(char *szDir);
+
+PT_VMR create_interface()
+{
+    PT_VMR vmr = &iVMR;
+    int rep;
+
+    rep = initialize_dll_interfaces(vmr);
+    if (rep < 0)
+    {
+        if (rep == -100)
+        {
+            log_fatal("Voicemeeter is not installed");
+            exit(EXIT_FAILURE);
+        }
+        else
+        {
+            log_fatal("Error loading Voicemeeter dll with code %d\n", rep);
+            exit(EXIT_FAILURE);
+        }
+    }
+
+    return vmr;
+}
+
+/*******************************************************************************/
+/**                                GET DLL INTERFACE                          **/
+/*******************************************************************************/
+static long initialize_dll_interfaces(PT_VMR vmr)
+{
+    HMODULE G_H_Module = NULL;
+    char szDllName[1024];
+    memset(vmr, 0, sizeof(T_VBVMR_INTERFACE));
+
+    // get Voicemeeter installation directory
+    if (!registry_get_voicemeeter_folder(szDllName))
+    {
+        // Voicemeeter not installed
+        return -100;
+    }
+    // use right dll according to O/S type
+    if (sizeof(void *) == 8)
+        strcat(szDllName, "\\VoicemeeterRemote64.dll");
+    else
+        strcat(szDllName, "\\VoicemeeterRemote.dll");
+
+    // Load Dll
+    G_H_Module = LoadLibrary(szDllName);
+    if (G_H_Module == NULL)
+        return -101;
+
+    // Get function pointers
+    vmr->VBVMR_Login = (T_VBVMR_Login)GetProcAddress(G_H_Module, "VBVMR_Login");
+    vmr->VBVMR_Logout = (T_VBVMR_Logout)GetProcAddress(G_H_Module, "VBVMR_Logout");
+    vmr->VBVMR_RunVoicemeeter = (T_VBVMR_RunVoicemeeter)GetProcAddress(G_H_Module, "VBVMR_RunVoicemeeter");
+    vmr->VBVMR_GetVoicemeeterType = (T_VBVMR_GetVoicemeeterType)GetProcAddress(G_H_Module, "VBVMR_GetVoicemeeterType");
+    vmr->VBVMR_GetVoicemeeterVersion = (T_VBVMR_GetVoicemeeterVersion)GetProcAddress(G_H_Module, "VBVMR_GetVoicemeeterVersion");
+
+    vmr->VBVMR_IsParametersDirty = (T_VBVMR_IsParametersDirty)GetProcAddress(G_H_Module, "VBVMR_IsParametersDirty");
+    vmr->VBVMR_GetParameterFloat = (T_VBVMR_GetParameterFloat)GetProcAddress(G_H_Module, "VBVMR_GetParameterFloat");
+    vmr->VBVMR_GetParameterStringA = (T_VBVMR_GetParameterStringA)GetProcAddress(G_H_Module, "VBVMR_GetParameterStringA");
+    vmr->VBVMR_GetParameterStringW = (T_VBVMR_GetParameterStringW)GetProcAddress(G_H_Module, "VBVMR_GetParameterStringW");
+    vmr->VBVMR_GetLevel = (T_VBVMR_GetLevel)GetProcAddress(G_H_Module, "VBVMR_GetLevel");
+    vmr->VBVMR_GetMidiMessage = (T_VBVMR_GetMidiMessage)GetProcAddress(G_H_Module, "VBVMR_GetMidiMessage");
+
+    vmr->VBVMR_SetParameterFloat = (T_VBVMR_SetParameterFloat)GetProcAddress(G_H_Module, "VBVMR_SetParameterFloat");
+    vmr->VBVMR_SetParameters = (T_VBVMR_SetParameters)GetProcAddress(G_H_Module, "VBVMR_SetParameters");
+    vmr->VBVMR_SetParametersW = (T_VBVMR_SetParametersW)GetProcAddress(G_H_Module, "VBVMR_SetParametersW");
+    vmr->VBVMR_SetParameterStringA = (T_VBVMR_SetParameterStringA)GetProcAddress(G_H_Module, "VBVMR_SetParameterStringA");
+    vmr->VBVMR_SetParameterStringW = (T_VBVMR_SetParameterStringW)GetProcAddress(G_H_Module, "VBVMR_SetParameterStringW");
+
+    vmr->VBVMR_Output_GetDeviceNumber = (T_VBVMR_Output_GetDeviceNumber)GetProcAddress(G_H_Module, "VBVMR_Output_GetDeviceNumber");
+    vmr->VBVMR_Output_GetDeviceDescA = (T_VBVMR_Output_GetDeviceDescA)GetProcAddress(G_H_Module, "VBVMR_Output_GetDeviceDescA");
+    vmr->VBVMR_Output_GetDeviceDescW = (T_VBVMR_Output_GetDeviceDescW)GetProcAddress(G_H_Module, "VBVMR_Output_GetDeviceDescW");
+    vmr->VBVMR_Input_GetDeviceNumber = (T_VBVMR_Input_GetDeviceNumber)GetProcAddress(G_H_Module, "VBVMR_Input_GetDeviceNumber");
+    vmr->VBVMR_Input_GetDeviceDescA = (T_VBVMR_Input_GetDeviceDescA)GetProcAddress(G_H_Module, "VBVMR_Input_GetDeviceDescA");
+    vmr->VBVMR_Input_GetDeviceDescW = (T_VBVMR_Input_GetDeviceDescW)GetProcAddress(G_H_Module, "VBVMR_Input_GetDeviceDescW");
+
+    vmr->VBVMR_MacroButton_IsDirty = (T_VBVMR_MacroButton_IsDirty)GetProcAddress(G_H_Module, "VBVMR_MacroButton_IsDirty");
+    vmr->VBVMR_MacroButton_GetStatus = (T_VBVMR_MacroButton_GetStatus)GetProcAddress(G_H_Module, "VBVMR_MacroButton_GetStatus");
+    vmr->VBVMR_MacroButton_SetStatus = (T_VBVMR_MacroButton_SetStatus)GetProcAddress(G_H_Module, "VBVMR_MacroButton_SetStatus");
+
+    // check pointers are valid
+    if (vmr->VBVMR_Login == NULL)
+        return -1;
+    if (vmr->VBVMR_Logout == NULL)
+        return -2;
+    if (vmr->VBVMR_RunVoicemeeter == NULL)
+        return -2;
+    if (vmr->VBVMR_GetVoicemeeterType == NULL)
+        return -3;
+    if (vmr->VBVMR_GetVoicemeeterVersion == NULL)
+        return -4;
+    if (vmr->VBVMR_IsParametersDirty == NULL)
+        return -5;
+    if (vmr->VBVMR_GetParameterFloat == NULL)
+        return -6;
+    if (vmr->VBVMR_GetParameterStringA == NULL)
+        return -7;
+    if (vmr->VBVMR_GetParameterStringW == NULL)
+        return -8;
+    if (vmr->VBVMR_GetLevel == NULL)
+        return -9;
+    if (vmr->VBVMR_SetParameterFloat == NULL)
+        return -10;
+    if (vmr->VBVMR_SetParameters == NULL)
+        return -11;
+    if (vmr->VBVMR_SetParametersW == NULL)
+        return -12;
+    if (vmr->VBVMR_SetParameterStringA == NULL)
+        return -13;
+    if (vmr->VBVMR_SetParameterStringW == NULL)
+        return -14;
+    if (vmr->VBVMR_GetMidiMessage == NULL)
+        return -15;
+
+    if (vmr->VBVMR_Output_GetDeviceNumber == NULL)
+        return -30;
+    if (vmr->VBVMR_Output_GetDeviceDescA == NULL)
+        return -31;
+    if (vmr->VBVMR_Output_GetDeviceDescW == NULL)
+        return -32;
+    if (vmr->VBVMR_Input_GetDeviceNumber == NULL)
+        return -33;
+    if (vmr->VBVMR_Input_GetDeviceDescA == NULL)
+        return -34;
+    if (vmr->VBVMR_Input_GetDeviceDescW == NULL)
+        return -35;
+
+    if (vmr->VBVMR_MacroButton_IsDirty == NULL)
+        return -36;
+    if (vmr->VBVMR_MacroButton_GetStatus == NULL)
+        return -37;
+    if (vmr->VBVMR_MacroButton_SetStatus == NULL)
+        return -38;
+
+    return 0;
+}
 
 /*******************************************************************************/
 /**                           GET VOICEMEETER DIRECTORY                       **/
@@ -13,7 +157,7 @@
 #define KEY_WOW64_32KEY 0x0200
 #endif
 
-bool __cdecl registry_get_voicemeeter_folder(char *szDir)
+static bool registry_get_voicemeeter_folder(char *szDir)
 {
     char szKey[256];
     char sss[1024];
@@ -54,106 +198,3 @@ bool __cdecl registry_get_voicemeeter_folder(char *szDir)
 
     return true;
 }
-
-/*******************************************************************************/
-/**                                GET DLL INTERFACE                          **/
-/*******************************************************************************/
-long initialize_dll_interfaces(T_VBVMR_INTERFACE *iVMR)
-{
-    HMODULE G_H_Module = NULL;
-    char szDllName[1024];
-    memset(iVMR, 0, sizeof(T_VBVMR_INTERFACE));
-
-    // get Voicemeeter installation directory
-    if (!registry_get_voicemeeter_folder(szDllName))
-    {
-        // Voicemeeter not installed
-        return -100;
-    }
-    // use right dll according to O/S type
-    if (sizeof(void *) == 8)
-        strcat(szDllName, "\\VoicemeeterRemote64.dll");
-    else
-        strcat(szDllName, "\\VoicemeeterRemote.dll");
-
-    // Load Dll
-    G_H_Module = LoadLibrary(szDllName);
-    if (G_H_Module == NULL)
-        return -101;
-
-    // Get function pointers
-    iVMR->VBVMR_Login = (T_VBVMR_Login)GetProcAddress(G_H_Module, "VBVMR_Login");
-    iVMR->VBVMR_Logout = (T_VBVMR_Logout)GetProcAddress(G_H_Module, "VBVMR_Logout");
-    iVMR->VBVMR_RunVoicemeeter = (T_VBVMR_RunVoicemeeter)GetProcAddress(G_H_Module, "VBVMR_RunVoicemeeter");
-    iVMR->VBVMR_GetVoicemeeterType = (T_VBVMR_GetVoicemeeterType)GetProcAddress(G_H_Module, "VBVMR_GetVoicemeeterType");
-    iVMR->VBVMR_GetVoicemeeterVersion = (T_VBVMR_GetVoicemeeterVersion)GetProcAddress(G_H_Module, "VBVMR_GetVoicemeeterVersion");
-
-    iVMR->VBVMR_IsParametersDirty = (T_VBVMR_IsParametersDirty)GetProcAddress(G_H_Module, "VBVMR_IsParametersDirty");
-    iVMR->VBVMR_GetParameterFloat = (T_VBVMR_GetParameterFloat)GetProcAddress(G_H_Module, "VBVMR_GetParameterFloat");
-    iVMR->VBVMR_GetParameterStringA = (T_VBVMR_GetParameterStringA)GetProcAddress(G_H_Module, "VBVMR_GetParameterStringA");
-    iVMR->VBVMR_GetParameterStringW = (T_VBVMR_GetParameterStringW)GetProcAddress(G_H_Module, "VBVMR_GetParameterStringW");
-    iVMR->VBVMR_GetLevel = (T_VBVMR_GetLevel)GetProcAddress(G_H_Module, "VBVMR_GetLevel");
-    iVMR->VBVMR_GetMidiMessage = (T_VBVMR_GetMidiMessage)GetProcAddress(G_H_Module, "VBVMR_GetMidiMessage");
-
-    iVMR->VBVMR_SetParameterFloat = (T_VBVMR_SetParameterFloat)GetProcAddress(G_H_Module, "VBVMR_SetParameterFloat");
-    iVMR->VBVMR_SetParameters = (T_VBVMR_SetParameters)GetProcAddress(G_H_Module, "VBVMR_SetParameters");
-    iVMR->VBVMR_SetParametersW = (T_VBVMR_SetParametersW)GetProcAddress(G_H_Module, "VBVMR_SetParametersW");
-    iVMR->VBVMR_SetParameterStringA = (T_VBVMR_SetParameterStringA)GetProcAddress(G_H_Module, "VBVMR_SetParameterStringA");
-    iVMR->VBVMR_SetParameterStringW = (T_VBVMR_SetParameterStringW)GetProcAddress(G_H_Module, "VBVMR_SetParameterStringW");
-
-    iVMR->VBVMR_Output_GetDeviceNumber = (T_VBVMR_Output_GetDeviceNumber)GetProcAddress(G_H_Module, "VBVMR_Output_GetDeviceNumber");
-    iVMR->VBVMR_Output_GetDeviceDescA = (T_VBVMR_Output_GetDeviceDescA)GetProcAddress(G_H_Module, "VBVMR_Output_GetDeviceDescA");
-    iVMR->VBVMR_Output_GetDeviceDescW = (T_VBVMR_Output_GetDeviceDescW)GetProcAddress(G_H_Module, "VBVMR_Output_GetDeviceDescW");
-    iVMR->VBVMR_Input_GetDeviceNumber = (T_VBVMR_Input_GetDeviceNumber)GetProcAddress(G_H_Module, "VBVMR_Input_GetDeviceNumber");
-    iVMR->VBVMR_Input_GetDeviceDescA = (T_VBVMR_Input_GetDeviceDescA)GetProcAddress(G_H_Module, "VBVMR_Input_GetDeviceDescA");
-    iVMR->VBVMR_Input_GetDeviceDescW = (T_VBVMR_Input_GetDeviceDescW)GetProcAddress(G_H_Module, "VBVMR_Input_GetDeviceDescW");
-
-    // check pointers are valid
-    if (iVMR->VBVMR_Login == NULL)
-        return -1;
-    if (iVMR->VBVMR_Logout == NULL)
-        return -2;
-    if (iVMR->VBVMR_RunVoicemeeter == NULL)
-        return -2;
-    if (iVMR->VBVMR_GetVoicemeeterType == NULL)
-        return -3;
-    if (iVMR->VBVMR_GetVoicemeeterVersion == NULL)
-        return -4;
-    if (iVMR->VBVMR_IsParametersDirty == NULL)
-        return -5;
-    if (iVMR->VBVMR_GetParameterFloat == NULL)
-        return -6;
-    if (iVMR->VBVMR_GetParameterStringA == NULL)
-        return -7;
-    if (iVMR->VBVMR_GetParameterStringW == NULL)
-        return -8;
-    if (iVMR->VBVMR_GetLevel == NULL)
-        return -9;
-    if (iVMR->VBVMR_SetParameterFloat == NULL)
-        return -10;
-    if (iVMR->VBVMR_SetParameters == NULL)
-        return -11;
-    if (iVMR->VBVMR_SetParametersW == NULL)
-        return -12;
-    if (iVMR->VBVMR_SetParameterStringA == NULL)
-        return -13;
-    if (iVMR->VBVMR_SetParameterStringW == NULL)
-        return -14;
-    if (iVMR->VBVMR_GetMidiMessage == NULL)
-        return -15;
-
-    if (iVMR->VBVMR_Output_GetDeviceNumber == NULL)
-        return -30;
-    if (iVMR->VBVMR_Output_GetDeviceDescA == NULL)
-        return -31;
-    if (iVMR->VBVMR_Output_GetDeviceDescW == NULL)
-        return -32;
-    if (iVMR->VBVMR_Input_GetDeviceNumber == NULL)
-        return -33;
-    if (iVMR->VBVMR_Input_GetDeviceDescA == NULL)
-        return -34;
-    if (iVMR->VBVMR_Input_GetDeviceDescW == NULL)
-        return -35;
-
-    return 0;
-}

src/util.c

@@ -3,6 +3,11 @@
 #include "vmr.h"
 #include "util.h"
 
+/**
+ * @brief Removes the last part of a path
+ *
+ * @param szPath
+ */
 void remove_name_in_path(char *szPath)
 {
     char *p = szPath;
@@ -57,9 +62,17 @@ int replace_multiple_space_with_one(char *s, size_t len)
     return j;
 }
 
-char *kind_as_string(char *s, enum kind kind, int n)
+/**
+ * @brief
+ *
+ * @param s Pointer to a character buffer
+ * @param kind The kind of Voicemeeter.
+ * @param n maximum number of characters to be written to the buffer
+ * @return char* The kind of Voicemeeter as a string
+ */
+char *kind_as_string(char *s, int kind, int n)
 {
-    char *kinds[] = {
+    static const char *kinds[] = {
         "Basic",
         "Banana",
         "Potato",

src/vmr.c

@@ -8,11 +8,21 @@
 #define VERSION_STR_LEN 128
 #define KIND_STR_LEN 64
 
-long login(T_VBVMR_INTERFACE *vmr, int kind)
+/**
+ * @brief Logs into the API.
+ * Tests for valid connection for up to 2 seconds.
+ * If successful initializes the dirty parameters.
+ *
+ * @param vmr
+ * @param kind
+ * @return long
+ */
+long login(PT_VMR vmr, int kind)
 {
     int rep;
     long v;
 
+    log_trace("VBVMR_Login()");
     rep = vmr->VBVMR_Login();
     if (rep == 1)
     {
@@ -21,111 +31,122 @@ long login(T_VBVMR_INTERFACE *vmr, int kind)
         log_info(
             "Launching Voicemeeter %s GUI",
             kind_as_string(kind_s, kind, KIND_STR_LEN));
-
-        time_t endwait;
-        int timeout = 2;
-
-        endwait = time(NULL) + timeout;
-        do
-        {
-            if ((rep = version(vmr, &v)) == 0)
-                break;
-            Sleep(50);
-        } while (time(NULL) < endwait);
     }
+
+    int timeout = 2;
+    time_t start = time(NULL);
+    do
+    {
+        if ((rep = version(vmr, &v)) == 0)
+        {
+            char version_s[VERSION_STR_LEN];
+            log_info(
+                "Successfully logged into the Voicemeeter API v%s",
+                version_as_string(version_s, v, VERSION_STR_LEN));
+            break;
+        }
+        Sleep(50);
+    } while (time(NULL) < start + timeout);
+
     if (rep == 0)
     {
-        version(vmr, &v);
-        char version_s[VERSION_STR_LEN];
-        log_info(
-            "Successfully logged into the Voicemeeter API v%s",
-            version_as_string(version_s, v, VERSION_STR_LEN));
         clear_dirty(vmr);
     }
     return rep;
 }
 
-long logout(T_VBVMR_INTERFACE *vmr)
+/**
+ * @brief Logs out of the API giving a short wait to allow a
+ * final instruction to complete.
+ *
+ * @param vmr The API interface as a struct
+ * @return long VBVMR_Logout return value
+ */
+long logout(PT_VMR vmr)
 {
     int rep;
 
     Sleep(20); /* give time for last command */
+    log_trace("VBVMR_Logout()");
     rep = vmr->VBVMR_Logout();
     if (rep == 0)
         log_info("Successfully logged out of the Voicemeeter API");
     return rep;
 }
 
-long run_voicemeeter(T_VBVMR_INTERFACE *vmr, int kind)
+long run_voicemeeter(PT_VMR vmr, int kind)
 {
     log_trace("VBVMR_RunVoicemeeter(%d)", kind);
     return vmr->VBVMR_RunVoicemeeter((long)kind);
 }
 
-long type(T_VBVMR_INTERFACE *vmr, long *type)
+long type(PT_VMR vmr, long *type)
 {
     log_trace("VBVMR_GetVoicemeeterType(<long> *t)");
     return vmr->VBVMR_GetVoicemeeterType(type);
 }
 
-long version(T_VBVMR_INTERFACE *vmr, long *version)
+long version(PT_VMR vmr, long *version)
 {
     log_trace("VBVMR_GetVoicemeeterVersion(<long> *v)");
     return vmr->VBVMR_GetVoicemeeterVersion(version);
 }
 
-bool is_pdirty(T_VBVMR_INTERFACE *vmr)
+bool is_pdirty(PT_VMR vmr)
 {
     log_trace("VBVMR_IsParametersDirty()");
     return vmr->VBVMR_IsParametersDirty() == 1;
 }
 
-long get_parameter_float(T_VBVMR_INTERFACE *vmr, char *param, float *f)
+long get_parameter_float(PT_VMR vmr, char *param, float *f)
 {
     log_trace("VBVMR_GetParameterFloat(%s, <float> *f)", param);
     return vmr->VBVMR_GetParameterFloat(param, f);
 }
 
-long get_parameter_string(T_VBVMR_INTERFACE *vmr, char *param, unsigned short *s)
+long get_parameter_string(PT_VMR vmr, char *param, unsigned short *s)
 {
     log_trace("VBVMR_GetParameterStringW(%s, <unsigned short> *s)", param);
     return vmr->VBVMR_GetParameterStringW(param, s);
 }
 
-long set_parameter_float(T_VBVMR_INTERFACE *vmr, char *param, float val)
+long set_parameter_float(PT_VMR vmr, char *param, float val)
 {
     log_trace("VBVMR_SetParameterFloat(%s, %.1f)", param, val);
     return vmr->VBVMR_SetParameterFloat(param, val);
 }
 
-long set_parameter_string(T_VBVMR_INTERFACE *vmr, char *param, char *s)
+long set_parameter_string(PT_VMR vmr, char *param, char *s)
 {
     log_trace("VBVMR_SetParameterStringA(%s, %s)", param, s);
     return vmr->VBVMR_SetParameterStringA(param, s);
 }
 
-long set_parameters(T_VBVMR_INTERFACE *vmr, char *command)
+long set_parameters(PT_VMR vmr, char *command)
 {
     log_trace("VBVMR_SetParameters(%s)", command);
     return vmr->VBVMR_SetParameters(command);
 }
 
-bool is_mdirty(T_VBVMR_INTERFACE *vmr)
+bool is_mdirty(PT_VMR vmr)
 {
+    log_trace("VBVMR_MacroButton_IsDirty()");
     return vmr->VBVMR_MacroButton_IsDirty() == 1;
 }
 
-long macrobutton_getstatus(T_VBVMR_INTERFACE *vmr, long n, float *val, long mode)
+long macrobutton_getstatus(PT_VMR vmr, long n, float *val, long mode)
 {
+    log_trace("VBVMR_MacroButton_GetStatus(%ld, <float> *v, %ld)", n, mode);
     return vmr->VBVMR_MacroButton_GetStatus(n, val, mode);
 }
 
-long macrobutton_setstatus(T_VBVMR_INTERFACE *vmr, long n, float val, long mode)
+long macrobutton_setstatus(PT_VMR vmr, long n, float val, long mode)
 {
+    log_trace("VBVMR_MacroButton_SetStatus(%ld, %d, %ld)", n, (int)val, mode);
     return vmr->VBVMR_MacroButton_SetStatus(n, val, mode);
 }
 
-void clear_dirty(T_VBVMR_INTERFACE *vmr)
+void clear_dirty(PT_VMR vmr)
 {
     Sleep(30);
     while (is_pdirty(vmr))

src/vmrcli.c

@@ -2,6 +2,8 @@
 #include <stdlib.h>
 #include <stdbool.h>
 #include <getopt.h>
+#include <string.h>
+#include <ctype.h>
 #include "cdll.h"
 #include "vmr.h"
 #include "log.h"
@@ -9,12 +11,21 @@
 
 #define MAX_LINE 512
 
+/**
+ * @brief An enum used to define the kind of value
+ * a 'get' call returns.
+ *
+ */
 enum
 {
     FLOAT_T,
     STRING_T,
 };
 
+/**
+ * @brief A struct holding the result of a get call.
+ *
+ */
 struct result
 {
     int type;
@@ -25,22 +36,24 @@ struct result
     } val;
 };
 
+static bool vflag = false;
+
 void help(void);
 enum kind set_kind(char *kval);
-int init_voicemeeter(T_VBVMR_INTERFACE *vmr, int kind);
+void interactive(PT_VMR vmr);
-void interactive(T_VBVMR_INTERFACE *vmr);
+void parse_input(PT_VMR vmr, char *input, int len);
-void parse_input(T_VBVMR_INTERFACE *vmr, char *input, int len);
+void parse_command(PT_VMR vmr, char *command);
-void parse_command(T_VBVMR_INTERFACE *vmr, char *command);
+void get(PT_VMR vmr, char *command, struct result *res);
-void get(T_VBVMR_INTERFACE *vmr, char *command, struct result *res);
-
-bool vflag = false;
 
 int main(int argc, char *argv[])
 {
-    bool iflag = false;
+    bool iflag = false,
+         mflag = false,
+         sflag = false,
+         pflag = false;
     int opt;
-    char *kvalue = "";
     int dvalue;
+    char *pvalue;
     enum kind kind = BANANAX64;
 
     if (argc == 1)
@@ -51,20 +64,34 @@ int main(int argc, char *argv[])
 
     log_set_level(LOG_WARN);
 
-    while ((opt = getopt(argc, argv, "k:ihD:v")) != -1)
+    while ((opt = getopt(argc, argv, "hk:msp:iD:v")) != -1)
     {
         switch (opt)
         {
-        case 'i':
-            iflag = true;
-            break;
-        case 'k':
-            kvalue = optarg;
-            kind = set_kind(kvalue);
-            break;
         case 'h':
             help();
             exit(EXIT_SUCCESS);
+        case 'k':
+            kind = set_kind(optarg);
+            if (kind == UNKNOWN)
+            {
+                log_fatal("Unknown Voicemeeter kind '%s'", optarg);
+                exit(EXIT_FAILURE);
+            }
+            break;
+        case 'm':
+            mflag = true;
+            break;
+        case 's':
+            sflag = true;
+            break;
+        case 'p':
+            pflag = true;
+            pvalue = optarg;
+            break;
+        case 'i':
+            iflag = true;
+            break;
         case 'D':
             dvalue = atoi(optarg);
             if (dvalue >= LOG_TRACE && dvalue <= LOG_FATAL)
@@ -73,7 +100,7 @@ int main(int argc, char *argv[])
             }
             else
             {
-                log_error(
+                log_warn(
                     "-D arg out of range, expected value from 0 up to 5\n"
                     "Log level will default to LOG_WARN (3).\n");
             }
@@ -86,15 +113,33 @@ int main(int argc, char *argv[])
         }
     }
 
-    T_VBVMR_INTERFACE iVMR;
+    PT_VMR vmr = create_interface();
-    T_VBVMR_INTERFACE *vmr = &iVMR;
 
-    int rep = init_voicemeeter(vmr, kind);
+    int rep = login(vmr, kind);
     if (rep != 0)
     {
+        log_fatal("Error logging into the Voicemeeter API");
         exit(EXIT_FAILURE);
     }
 
+    if (mflag)
+    {
+        log_info("MacroButtons app launched");
+        run_voicemeeter(vmr, MACROBUTTONS);
+    }
+
+    if (sflag)
+    {
+        log_info("StreamerView app launched");
+        run_voicemeeter(vmr, STREAMERVIEW);
+    }
+
+    if (pflag)
+    {
+        log_info("Profile %s loaded", pvalue);
+        set_parameter_string(vmr, "command.load", pvalue);
+    }
+
     if (iflag)
     {
         puts("Interactive mode enabled. Enter 'Q' to exit.");
@@ -110,25 +155,33 @@ int main(int argc, char *argv[])
 
     rep = logout(vmr);
     if (rep == 0)
+    {
         return EXIT_SUCCESS;
+    }
     else
+    {
+        log_fatal("Error logging out of the Voicemeeter API");
         return EXIT_FAILURE;
+    }
 }
 
 /**
- * @brief prints the help dialogue
+ * @brief prints the help message
  *
  */
 void help()
 {
     puts(
-        "Usage: ./vmrcli.exe [-h] [-i] [-k] [-D] [-v] <api commands>\n"
+        "Usage: ./vmrcli.exe [-h] [-i] [-k] [-D] [-v] [-p] [-m] [-s] <api commands>\n"
         "Where: \n"
-        "\th: Prints the help dialogue\n"
+        "\th: Prints the help message\n"
         "\ti: Enable interactive mode\n"
         "\tk: The kind of Voicemeeter (basic, banana, potato)\n"
-        "\tD: Set log level 0=TRACE, 1=DEBUG, 2=INFO, 3=WARN, 4=ERROR, 5=FATAL"
+        "\tD: Set log level 0=TRACE, 1=DEBUG, 2=INFO, 3=WARN, 4=ERROR, 5=FATAL\n"
-        "\tv: Enable extra console output (toggle, set messages)\n");
+        "\tv: Enable extra console output (toggle, set messages)\n"
+        "\tp: Load a user configuration (given the file name or a full path)\n"
+        "\tm: Launch the MacroButtons application\n"
+        "\ts: Launch the StreamerView application");
 }
 
 /**
@@ -162,38 +215,18 @@ enum kind set_kind(char *kval)
     }
     else
     {
-        log_error("Unknown Voicemeeter kind '%s'\n", kval);
+        return UNKNOWN;
-        exit(EXIT_FAILURE);
     }
 }
 
-int init_voicemeeter(T_VBVMR_INTERFACE *vmr, int kind)
+/**
-{
+ * @brief Continuously read lines from stdin.
-    int rep = initialize_dll_interfaces(vmr);
+ * Break if 'Q' is entered on the interactive prompt.
-    if (rep < 0)
+ * Each line is passed to parse_input()
-    {
+ *
-        if (rep == -100)
+ * @param vmr The API interface as a struct
-        {
+ */
-            log_error("Voicemeeter is not installed");
+void interactive(PT_VMR vmr)
-        }
-        else
-        {
-            log_error("Error loading Voicemeeter dll with code %d\n", rep);
-        }
-        return rep;
-    }
-
-    rep = login(vmr, kind);
-    if (rep != 0)
-    {
-        log_error("Error logging into Voicemeeter");
-        return rep;
-    }
-
-    return 0;
-}
-
-void interactive(T_VBVMR_INTERFACE *vmr)
 {
     char input[MAX_LINE];
     size_t len;
@@ -213,7 +246,15 @@ void interactive(T_VBVMR_INTERFACE *vmr)
     }
 }
 
-void parse_input(T_VBVMR_INTERFACE *vmr, char *input, int len)
+/**
+ * @brief Walks through each line split by a space delimiter.
+ * Each token is passed to parse_command()
+ *
+ * @param vmr The API interface as a struct
+ * @param input Each input line, from stdin or CLI args
+ * @param len The length of the input line
+ */
+void parse_input(PT_VMR vmr, char *input, int len)
 {
     char *token;
 
@@ -226,7 +267,15 @@ void parse_input(T_VBVMR_INTERFACE *vmr, char *input, int len)
     }
 }
 
-void parse_command(T_VBVMR_INTERFACE *vmr, char *command)
+/**
+ * @brief Execute each command according to type.
+ * See command type definitions in:
+ * https://github.com/onyx-and-iris/vmrcli?tab=readme-ov-file#api-commands
+ *
+ * @param vmr The API interface as a struct
+ * @param command Each token from the input line as its own command string
+ */
+void parse_command(PT_VMR vmr, char *command)
 {
     log_debug("Parsing %s", command);
 
@@ -279,7 +328,14 @@ void parse_command(T_VBVMR_INTERFACE *vmr, char *command)
     }
 }
 
-void get(T_VBVMR_INTERFACE *vmr, char *command, struct result *res)
+/**
+ * @brief
+ *
+ * @param vmr The API interface as a struct
+ * @param command A parsed 'get' command as a string
+ * @param res A struct holding the result of the API call.
+ */
+void get(PT_VMR vmr, char *command, struct result *res)
 {
     clear_dirty(vmr);
     if (get_parameter_float(vmr, command, &res->val.f) != 0)