remove workflow

gcc version
artifact path

.env

@@ -0,0 +1 @@
+LOG_USE_COLOR=yes

.gitignore

@@ -51,4 +51,9 @@ Module.symvers
 Mkfile.old
 dkms.conf
 
-.vscode/
+# Task Runner
+.task/
+
+.vscode/
+
+test*

README.md

@@ -13,13 +13,14 @@
 ## `Use`
 
 ```powershell
-.\vmrcli.exe [-h] [-i] [-k] [-D] [-v] [-c] [-m] [-s] <api commands>
+.\vmrcli.exe [-h] [-i|-I] [-k] [-D] [-v] [-c] [-m] [-s] <api commands>
 ```
 
 Where:
 
 - `h`: Prints the help message.
-- `i`: Enable interactive mode. If set, any api commands passed on the command line will be ignored.
+- `i`: Enable interactive mode, use (-I) to disable the '>>' prompt.
+  - 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)
@@ -47,6 +48,18 @@ Launch banana GUI, set log level to DEBUG, set Strip 0 label to podmic then prin
 .\vmrcli.exe -kbanana -D1 strip[0].label=podmic strip[2].label
 ```
 
+#### `Quick Commands`
+
+A short list of quick commands are available:
+
+- `lock`: command.lock=1
+- `unlock`: command.lock=0
+- `show`: command.show=1
+- `hide`: command.show=0
+- `restart`: command.restart=1
+
+They may be used in direct or interactive mode.
+
 ## `Interactive Mode`
 
 Running the following command in Powershell:
@@ -75,11 +88,13 @@ Scripts can be loaded from text files, for example in Powershell:
 You may also pipe a scripts contents to the CLI:
 
 ```powershell
-$(Get-Content .\example_commands.txt) | .\vmrcli.exe -D1 -i
+$(Get-Content .\example_commands.txt) | .\vmrcli.exe -D1 -I
 ```
 
 Multiple API commands can be in a single line, they may be separated by space, `;` or `,`.
 
+Lines starting with `#` will be interpreted as comments.
+
 ## `Build`
 
 Run the included `makefile` with [GNU Make](https://www.gnu.org/software/make/).

Taskfile.yml

@@ -0,0 +1,71 @@
+version: '3'
+
+dotenv: ['.env']
+
+vars:
+  PROGRAM: vmrcli
+  SHELL: pwsh
+
+  CC: gcc
+
+  SRC_DIR: src
+  INC_DIR: include
+  OBJ_DIR: obj
+  BIN_DIR: bin
+
+  CPPFLAGS: -I{{.INC_DIR}} -MMD -MP {{if eq .LOG_USE_COLOR "yes"}}-DLOG_USE_COLOR{{end}}
+
+  CFLAGS: -O -Wall -W -pedantic -ansi -std=c2x
+  LDFLAGS: -Llib
+  LDLIBS: -lm
+
+tasks:
+  default:
+    desc: Build vmrcli for Windows
+    deps: [build]
+
+  build:
+    desc: Build vmrcli for Windows
+    deps: [link]
+
+  link:
+    desc: Link all files in obj/ for Windows
+    deps: [compile]
+    cmds:
+      - |
+        {{.SHELL}} -Command "
+        if (!(Test-Path -Path '{{.BIN_DIR}}')) { 
+          New-Item -ItemType Directory -Path '{{.BIN_DIR}}' 
+        }
+
+        {{.CC}} {{.LDFLAGS}} {{.OBJ_DIR}}/*.o {{.LDLIBS}} -o {{.BIN_DIR}}/{{.PROGRAM}}.exe"
+    sources:
+      - '{{.OBJ_DIR}}/**'
+    generates:
+      - '{{.BIN_DIR}}/{{.PROGRAM}}.exe'
+
+  compile:
+    desc: Compile all files in src/ and include/ for Windows
+    cmds:
+      - |
+        {{.SHELL}} -Command "
+        if (!(Test-Path -Path '{{.OBJ_DIR}}')) { 
+          New-Item -ItemType Directory -Path '{{.OBJ_DIR}}' 
+        }
+
+        Get-ChildItem -Path '{{.SRC_DIR}}' -Filter '*.c' | 
+        ForEach-Object { \$_.Name -replace '\.c$', '' } | 
+        ForEach-Object { {{.CC}} {{.CPPFLAGS}} {{.CFLAGS}} -c {{.SRC_DIR}}/\$_.c -o {{.OBJ_DIR}}/\$_.o }"
+    sources:
+      - '{{.SRC_DIR}}/**'
+      - '{{.INC_DIR}}/**'
+    generates:
+      - '{{.OBJ_DIR}}/**'
+
+  clean:
+    desc: Remove all files in obj/ and bin/
+    cmds:
+      - |
+        {{.SHELL}} -Command "
+        if (Test-Path -Path '{{.OBJ_DIR}}') { Remove-Item -Path '{{.OBJ_DIR}}' -Recurse -Force }
+        if (Test-Path -Path '{{.BIN_DIR}}') { Remove-Item -Path '{{.BIN_DIR}}' -Recurse -Force }"

example_commands.txt

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

include/interface.h

@@ -10,6 +10,8 @@
 
 #include "VoicemeeterRemote.h"
 
+#define IS_64_BIT sizeof(void *) == 8
+
 PT_VMR create_interface();
 
 #endif /* __IVMR_H__ */

include/util.h

@@ -8,8 +8,16 @@
 #ifndef __UTIL_H__
 #define __UTIL_H__
 
+struct quickcommand
+{
+    char *name;
+    char *fullcommand;
+};
+
 void remove_last_part_of_path(char *fullpath);
 char *kind_as_string(char *s, int kind, int n);
 char *version_as_string(char *s, long v, int n);
+bool is_comment(char *s);
+struct quickcommand *command_in_quickcommands(const char *command, const struct quickcommand *quickcommands, int n);
 
 #endif /* __UTIL_H__ */

include/wrapper.h

@@ -11,7 +11,7 @@
 #include <stdbool.h>
 #include "voicemeeterRemote.h"
 
-enum kind
+enum kind : int
 {
     UNKNOWN = -1,
     BASIC = 1,
@@ -32,7 +32,7 @@ long version(PT_VMR vmr, long *version);
 
 bool is_pdirty(PT_VMR vmr);
 long get_parameter_float(PT_VMR vmr, char *param, float *f);
-long get_parameter_string(PT_VMR vmr, char *param, unsigned short *s);
+long get_parameter_string(PT_VMR vmr, char *param, wchar_t *s);
 long set_parameter_float(PT_VMR vmr, char *param, float val);
 long set_parameter_string(PT_VMR vmr, char *param, char *s);
 long set_parameters(PT_VMR vmr, char *command);
@@ -41,6 +41,6 @@ bool is_mdirty(PT_VMR vmr);
 long macrobutton_getstatus(PT_VMR vmr, long n, float *val, long mode);
 long macrobutton_setstatus(PT_VMR vmr, long n, float val, long mode);
 
-void clear_dirty(PT_VMR vmr);
+void clear(PT_VMR vmr, bool (*f)(PT_VMR));
 
 #endif /* __WRAPPER_H__ */

makefile

@@ -1,38 +1,53 @@
+# Program name
 program = vmrcli
 
+# Compiler
 CC = gcc
+
+# Directories
 SRC_DIR := src
 OBJ_DIR := obj
 BIN_DIR := bin
 
+# Executable and source/object files
 EXE := $(BIN_DIR)/$(program).exe
 SRC := $(wildcard $(SRC_DIR)/*.c)
 OBJ := $(SRC:$(SRC_DIR)/%.c=$(OBJ_DIR)/%.o)
 
+# Conditional compilation flags for logging
 LOG_USE_COLOR ?= yes
 ifeq ($(LOG_USE_COLOR), yes)
 	CPPFLAGS := -Iinclude -MMD -MP -DLOG_USE_COLOR
 else
 	CPPFLAGS := -Iinclude -MMD -MP
 endif
+
+# Compiler and linker flags
 CFLAGS = -O -Wall -W -pedantic -ansi -std=c2x
 LDFLAGS  := -Llib
 LDLIBS   := -lm
 
+# Phony targets
 .PHONY: all clean
 
+# Default target
 all: $(EXE)
 
+# Link the executable
 $(EXE): $(OBJ) | $(BIN_DIR)
 	$(CC) $(LDFLAGS) $^ $(LDLIBS) -o $@
 
+# Compile source files to object files
 $(OBJ_DIR)/%.o: $(SRC_DIR)/%.c | $(OBJ_DIR)
 	$(CC) $(CPPFLAGS) $(CFLAGS) -c $< -o $@
 
+# Create necessary directories
 $(BIN_DIR) $(OBJ_DIR):
 	pwsh -Command New-Item -Path $@ -ItemType Directory
 
+# Clean up generated files
 clean:
-	pwsh -Command Remove-Item -Recurse $(EXE), $(OBJ_DIR)
+	pwsh -Command Remove-Item -Recurse $(BIN_DIR), $(OBJ_DIR) -force
 
+# Include dependency files
 -include $(OBJ:.o=.d)

src/interface.c

@@ -1,9 +1,9 @@
 /**
- * @file ivmr.c
+ * @file interface.c
  * @author Vincent Burel, Onyx and Iris (code@onyxandiris.online)
  * @brief Functions for initializing the iVMR interface.
  * Defines a single public function that returns a pointer to the interface.
- * @version 0.7.0
+ * @version 0.11.0
  * @date 2024-07-06
  *
  * @copyright Vincent Burel(c)2015-2021 All Rights Reserved
@@ -13,41 +13,49 @@
  * https://github.com/onyx-and-iris/vmrcli/blob/main/LICENSE
  */
 
-#include <stdbool.h>
-#include <stdio.h>
 #include <windows.h>
-#include "ivmr.h"
+#include "interface.h"
 #include "util.h"
 #include "log.h"
 
-static T_VBVMR_INTERFACE iVMR;
+#define PRAGMA_IgnoreWCastIncompatibleFuncTypes \
+    _Pragma("GCC diagnostic push")              \
+        _Pragma("GCC diagnostic ignored \"-Wcast-function-type\"")
+
+#define PRAGMA_Pop \
+    _Pragma("GCC diagnostic pop")
 
 static long initialize_dll_interfaces(PT_VMR vmr);
-static bool registry_get_voicemeeter_folder(char *szDir);
+static bool registry_get_voicemeeter_folder(char *dll_fullpath);
 
 /**
  * @brief Create an interface object
  *
  * @return PT_VMR Pointer to the iVMR interface
+ * May return NULL if the interface fails to initialize
  */
 PT_VMR create_interface()
 {
-    PT_VMR vmr = &iVMR;
+    PT_VMR vmr = malloc(sizeof(T_VBVMR_INTERFACE));
-    int rep;
+    if (vmr == NULL)
+    {
+        log_error("malloc failed to allocate memory");
+        return NULL;
+    }
 
-    rep = initialize_dll_interfaces(vmr);
+    LONG 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);
+            log_fatal("Error loading Voicemeeter dll with code %d", rep);
-            exit(EXIT_FAILURE);
         }
+        free(vmr);
+        vmr = NULL;
     }
 
     return vmr;
@@ -56,29 +64,35 @@ PT_VMR create_interface()
 /*******************************************************************************/
 /**                                GET DLL INTERFACE                          **/
 /*******************************************************************************/
+#define DLL_FULLPATH_SZ 1024
+#define DLL64_NAME "\\VoicemeeterRemote64.dll"
+#define DLL32_NAME "\\VoicemeeterRemote.dll"
+
 static long initialize_dll_interfaces(PT_VMR vmr)
 {
     HMODULE G_H_Module = NULL;
-    char szDllName[1024];
+    char dll_fullpath[DLL_FULLPATH_SZ];
     memset(vmr, 0, sizeof(T_VBVMR_INTERFACE));
 
     // get Voicemeeter installation directory
-    if (!registry_get_voicemeeter_folder(szDllName))
+    if (!registry_get_voicemeeter_folder(dll_fullpath))
     {
         // Voicemeeter not installed
         return -100;
     }
     // use right dll according to O/S type
-    if (sizeof(void *) == 8)
+    if (IS_64_BIT)
-        strcat(szDllName, "\\VoicemeeterRemote64.dll");
+        strncat(dll_fullpath, DLL64_NAME, DLL_FULLPATH_SZ - strlen(DLL64_NAME) - 1);
     else
-        strcat(szDllName, "\\VoicemeeterRemote.dll");
+        strncat(dll_fullpath, DLL32_NAME, DLL_FULLPATH_SZ - strlen(DLL32_NAME) - 1);
 
     // Load Dll
-    G_H_Module = LoadLibrary(szDllName);
+    G_H_Module = LoadLibrary(dll_fullpath);
     if (G_H_Module == NULL)
         return -101;
 
+    PRAGMA_IgnoreWCastIncompatibleFuncTypes;
+
     // 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");
@@ -110,39 +124,41 @@ static long initialize_dll_interfaces(PT_VMR vmr)
     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");
 
+    PRAGMA_Pop;
+
     // 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)
+    if (vmr->VBVMR_GetVoicemeeterType == NULL)
         return -4;
-    if (vmr->VBVMR_IsParametersDirty == NULL)
+    if (vmr->VBVMR_GetVoicemeeterVersion == NULL)
         return -5;
-    if (vmr->VBVMR_GetParameterFloat == NULL)
+    if (vmr->VBVMR_IsParametersDirty == NULL)
         return -6;
-    if (vmr->VBVMR_GetParameterStringA == NULL)
+    if (vmr->VBVMR_GetParameterFloat == NULL)
         return -7;
-    if (vmr->VBVMR_GetParameterStringW == NULL)
+    if (vmr->VBVMR_GetParameterStringA == NULL)
         return -8;
-    if (vmr->VBVMR_GetLevel == NULL)
+    if (vmr->VBVMR_GetParameterStringW == NULL)
         return -9;
-    if (vmr->VBVMR_SetParameterFloat == NULL)
+    if (vmr->VBVMR_GetLevel == NULL)
         return -10;
-    if (vmr->VBVMR_SetParameters == NULL)
+    if (vmr->VBVMR_SetParameterFloat == NULL)
         return -11;
-    if (vmr->VBVMR_SetParametersW == NULL)
+    if (vmr->VBVMR_SetParameters == NULL)
         return -12;
-    if (vmr->VBVMR_SetParameterStringA == NULL)
+    if (vmr->VBVMR_SetParametersW == NULL)
         return -13;
-    if (vmr->VBVMR_SetParameterStringW == NULL)
+    if (vmr->VBVMR_SetParameterStringA == NULL)
         return -14;
-    if (vmr->VBVMR_GetMidiMessage == NULL)
+    if (vmr->VBVMR_SetParameterStringW == NULL)
         return -15;
+    if (vmr->VBVMR_GetMidiMessage == NULL)
+        return -16;
 
     if (vmr->VBVMR_Output_GetDeviceNumber == NULL)
         return -30;
@@ -171,50 +187,48 @@ static long initialize_dll_interfaces(PT_VMR vmr)
 /**                           GET VOICEMEETER DIRECTORY                       **/
 /*******************************************************************************/
 
+#define INSTALLER_DIR_KEY "SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Uninstall"
 #define INSTALLER_UNINST_KEY "VB:Voicemeeter {17359A74-1236-5467}"
 
 #ifndef KEY_WOW64_32KEY
 #define KEY_WOW64_32KEY 0x0200
 #endif
 
-static bool registry_get_voicemeeter_folder(char *szDir)
+#define UNINSTALL_KEY_SZ 256
-{
+#define UNINSTALL_PATH_SZ 1024
-    char szKey[256];
-    char sss[1024];
-    DWORD nnsize = 1024;
-    HKEY hkResult;
-    LONG rep;
-    DWORD pptype = REG_SZ;
-    sss[0] = 0;
-    const char uninstDirKey[] = "SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Uninstall";
 
+static bool registry_get_voicemeeter_folder(char *dll_fullpath)
+{
     // build Voicemeeter uninstallation key
-    strcpy(szKey, uninstDirKey);
+    char uninstall_key[UNINSTALL_KEY_SZ];
-    strcat(szKey, "\\");
+    snprintf(uninstall_key, UNINSTALL_KEY_SZ, "%s\\%s", INSTALLER_DIR_KEY, INSTALLER_UNINST_KEY);
-    strcat(szKey, INSTALLER_UNINST_KEY);
 
     // open key
-    rep = RegOpenKeyEx(HKEY_LOCAL_MACHINE, szKey, 0, KEY_READ, &hkResult);
+    HKEY result;
+    LONG rep = RegOpenKeyEx(HKEY_LOCAL_MACHINE, uninstall_key, 0, KEY_READ, &result);
     if (rep != ERROR_SUCCESS)
     {
         // if not present we consider running in 64bit mode and force to read 32bit registry
-        rep = RegOpenKeyEx(HKEY_LOCAL_MACHINE, szKey, 0, KEY_READ | KEY_WOW64_32KEY, &hkResult);
+        rep = RegOpenKeyEx(HKEY_LOCAL_MACHINE, uninstall_key, 0, KEY_READ | KEY_WOW64_32KEY, &result);
     }
     if (rep != ERROR_SUCCESS)
         return false;
+
     // read uninstall path from registry
-    rep = RegQueryValueEx(hkResult, "UninstallString", 0, &pptype, (unsigned char *)sss, &nnsize);
+    DWORD pptype = REG_SZ;
-    RegCloseKey(hkResult);
+    DWORD len_uninstall_path = UNINSTALL_PATH_SZ;
+    char uninstall_path[UNINSTALL_PATH_SZ] = {0};
+    rep = RegQueryValueEx(result, "UninstallString", 0, &pptype, (unsigned char *)uninstall_path, &len_uninstall_path);
+    RegCloseKey(result);
 
     if (pptype != REG_SZ)
         return false;
     if (rep != ERROR_SUCCESS)
         return false;
+
     // remove name to get the path only
-    remove_last_part_of_path(sss);
+    remove_last_part_of_path(uninstall_path);
-    if (nnsize > 512)
+    snprintf(dll_fullpath, DLL_FULLPATH_SZ, uninstall_path);
-        nnsize = 512;
-    strncpy(szDir, sss, nnsize);
 
     return true;
 }

src/log.c

@@ -118,7 +118,7 @@ void log_set_quiet(bool enable)
 
 int log_add_callback(log_LogFn fn, void *udata, int level)
 {
-    for (int i = 0; i < MAX_CALLBACKS; i++)
+    for (int i = 0; i < MAX_CALLBACKS; ++i)
     {
         if (!L.callbacks[i].fn)
         {
@@ -163,7 +163,7 @@ void log_log(int level, const char *file, int line, const char *fmt, ...)
         va_end(ev.ap);
     }
 
-    for (int i = 0; i < MAX_CALLBACKS && L.callbacks[i].fn; i++)
+    for (int i = 0; i < MAX_CALLBACKS && L.callbacks[i].fn; ++i)
     {
         Callback *cb = &L.callbacks[i];
         if (level >= cb->level)

src/util.c

@@ -2,24 +2,21 @@
  * @file util.c
  * @author Onyx and Iris (code@onyxandiris.online)
  * @brief Utility functions.
- * @version 0.7.0
+ * @version 0.11.0
  * @date 2024-07-06
  *
  * @copyright Copyright (c) 2024
  * https://github.com/onyx-and-iris/vmrcli/blob/main/LICENSE
  */
 
-#include <stddef.h>
 #include <stdio.h>
 #include <string.h>
-#include <ctype.h>
-#include "wrapper.h"
 #include "util.h"
 
 /**
  * @brief Removes the last part of a path
  *
- * @param fullpath The entire path
+ * @param fullpath
  */
 void remove_last_part_of_path(char *fullpath)
 {
@@ -34,7 +31,7 @@ void remove_last_part_of_path(char *fullpath)
 /**
  * @brief Converts Voicemeeter's kind into a string.
  *
- * @param s Pointer to a character buffer
+ * @param s Pointer to a character buffer receiving the kind
  * @param kind The kind of Voicemeeter.
  * @param n Maximum number of characters to be written to the buffer
  * @return char* String representation of the kind of Voicemeeter.
@@ -56,7 +53,7 @@ char *kind_as_string(char *s, int kind, int n)
 /**
  * @brief Converts Voicemeeter's version into a string.
  *
- * @param s Pointer to a character buffer
+ * @param s Pointer to a character buffer receiving the version
  * @param v Unprocessed version as a long int
  * @param n Maximum number of characters to be written to the buffer
  * @return char* String representation of the Voicemeeter version
@@ -69,4 +66,38 @@ char *version_as_string(char *s, long v, int n)
          v4 = (v & 0x000000FF);
     snprintf(s, n, "%i.%i.%i.%i", (int)v1, (int)v2, (int)v3, (int)v4);
     return s;
-}
+}
+
+/**
+ * @brief Is the current input a comment
+ *
+ * @param s Pointer to the current input
+ * @return true
+ * @return false
+ */
+bool is_comment(char *s)
+{
+    return s[0] == '#';
+}
+
+/**
+ * @brief Searches the quickcommands array for a quickcommand
+ * corresponding to the command_key.
+ *
+ * @param command_key The key used to search for the quickcommand
+ * @param quickcommands Pointer to an array of quickcommands
+ * @param n The number of quickcommands
+ * @return struct quickcommand* Pointer to the found quickcommand
+ * May return NULL if quickcommand not found.
+ */
+struct quickcommand *command_in_quickcommands(const char *command_key, const struct quickcommand *quickcommands, int n)
+{
+    for (int i = 0; i < n; ++i)
+    {
+        if (strcmp(command_key, quickcommands[i].name) == 0)
+        {
+            return (struct quickcommand *)(quickcommands + i);
+        }
+    }
+    return NULL;
+}

src/vmrcli.c

@@ -2,7 +2,7 @@
  * @file vmrcli.c
  * @author Onyx and Iris (code@onyxandiris.online)
  * @brief A Voicemeeter Remote Command Line Interface
- * @version 0.7.0
+ * @version 0.11.0
  * @date 2024-07-06
  *
  * @copyright Copyright (c) 2024
@@ -11,66 +11,70 @@
 
 #include <stdio.h>
 #include <stdlib.h>
-#include <stdbool.h>
 #include <getopt.h>
-#include <string.h>
-#include <ctype.h>
 #include <windows.h>
-#include "ivmr.h"
+#include "interface.h"
 #include "wrapper.h"
 #include "log.h"
 #include "util.h"
 
-#define USAGE "Usage: .\\vmrcli.exe [-h] [-i] [-k] [-D] [-v] [-c] [-m] [-s] <api commands>\n" \
+#define USAGE "Usage: .\\vmrcli.exe [-h] [-i|-I] [-k] [-D] [-v] [-c] [-m] [-s] <api commands>\n" \
-              "Where: \n"                                                                     \
+              "Where: \n"                                                                        \
-              "\th: Prints the help message\n"                                                \
+              "\th: Prints the help message\n"                                                   \
-              "\ti: Enable interactive mode\n"                                                \
+              "\ti: Enable interactive mode, use (-I) to disable the '>>' prompt\n"              \
-              "\tk: The kind of Voicemeeter (basic, banana, potato)\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\n"       \
+              "\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"                        \
-              "\tc: Load a user configuration (give the full file path)\n"                    \
+              "\tc: Load a user configuration (give the full file path)\n"                       \
-              "\tm: Launch the MacroButtons application\n"                                    \
+              "\tm: Launch the MacroButtons application\n"                                       \
               "\ts: Launch the StreamerView application"
-#define OPTSTR ":hk:msc:iD:v"
+#define OPTSTR ":hk:msc:iID:v"
-#define MAX_LINE 512
+#define MAX_LINE 4096 /* Size of the input buffer */
+#define RES_SZ 512    /* Size of the buffer passed to VBVMR_GetParameterStringW */
+#define COUNT_OF(x) (sizeof(x) / sizeof(x[0]))
+#define DELIMITERS " \t;,"
 
 /**
  * @enum The kind of values a get call may return.
  */
-enum
+enum restype : int
 {
     FLOAT_T,
     STRING_T,
 };
 
 /**
- * @struct A struct holding the result of a get call.
+ * @struct A struct used for:
+ * - tracking the type of value stored
+ * - storing the result of a get call
  */
 struct result
 {
-    int type;
+    enum restype type;
     union val
     {
         float f;
-        wchar_t s[MAX_LINE];
+        wchar_t s[RES_SZ];
     } val;
 };
 
 static bool vflag = false;
 
-static void usage(void);
+static void terminate(PT_VMR vmr, char *msg);
-enum kind set_kind(char *kval);
+static void usage();
-void interactive(PT_VMR vmr);
+static enum kind set_kind(char *kval);
-void parse_input(PT_VMR vmr, char *input);
+static void interactive(PT_VMR vmr, bool with_prompt);
-void parse_command(PT_VMR vmr, char *command);
+static void parse_input(PT_VMR vmr, char *input);
-void get(PT_VMR vmr, char *command, struct result *res);
+static void parse_command(PT_VMR vmr, char *command);
+static void get(PT_VMR vmr, char *command, struct result *res);
 
 int main(int argc, char *argv[])
 {
     bool iflag = false,
          mflag = false,
          sflag = false,
-         cflag = false;
+         cflag = false,
+         with_prompt = true;
     int opt;
     int dvalue;
     char *cvalue;
@@ -106,6 +110,9 @@ int main(int argc, char *argv[])
             cflag = true;
             cvalue = optarg;
             break;
+        case 'I':
+            with_prompt = false;
+            [[fallthrough]];
         case 'i':
             iflag = true;
             break;
@@ -143,61 +150,79 @@ int main(int argc, char *argv[])
     }
 
     PT_VMR vmr = create_interface();
+    if (vmr == NULL)
+    {
+        exit(EXIT_FAILURE);
+    }
 
-    int rep = login(vmr, kind);
+    long rep = login(vmr, kind);
     if (rep != 0)
     {
-        log_fatal("Error logging into the Voicemeeter API");
+        if (rep == -2)
-        exit(EXIT_FAILURE);
+            terminate(vmr, "Timeout logging into the API.");
+        else
+            terminate(vmr, "Error logging into the Voicemeeter API");
     }
 
     if (mflag)
     {
-        log_info("MacroButtons app launched");
         run_voicemeeter(vmr, MACROBUTTONS);
+        log_info("MacroButtons app launched");
     }
 
     if (sflag)
     {
-        log_info("StreamerView app launched");
         run_voicemeeter(vmr, STREAMERVIEW);
+        log_info("StreamerView app launched");
     }
 
     if (cflag)
     {
-        log_info("Profile %s loaded", cvalue);
         set_parameter_string(vmr, "command.load", cvalue);
+        log_info("Profile %s loaded", cvalue);
         Sleep(300);
-        clear_dirty(vmr);
+        clear(vmr, is_pdirty);
     }
 
     if (iflag)
     {
         puts("Interactive mode enabled. Enter 'Q' to exit.");
-        interactive(vmr);
+        interactive(vmr, with_prompt);
     }
     else
     {
-        for (int i = optind; i < argc; i++)
+        for (int i = optind; i < argc; ++i)
         {
             parse_input(vmr, argv[i]);
         }
     }
 
     rep = logout(vmr);
-    if (rep == 0)
+    if (rep != 0)
     {
-        return EXIT_SUCCESS;
+        terminate(vmr, "Error logging out of the Voicemeeter API");
-    }
-    else
-    {
-        log_fatal("Error logging out of the Voicemeeter API");
-        return EXIT_FAILURE;
     }
+
+    log_info("Successfully logged out of the Voicemeeter API");
+    free(vmr);
+    return EXIT_SUCCESS;
 }
 
 /**
- * @brief prints the help message
+ * @brief Write fatal error log, free dyn allocated memory then exit
+ *
+ * @param vmr Pointer to the iVMR interface
+ * @param msg Fatal error message
+ */
+static void terminate(PT_VMR vmr, char *msg)
+{
+    log_fatal(msg);
+    free(vmr);
+    exit(EXIT_FAILURE);
+}
+
+/**
+ * @brief Prints the help message
  */
 static void usage()
 {
@@ -212,14 +237,14 @@ static void usage()
  * @param kval Value of the -k flag
  * @return enum kind
  */
-enum kind set_kind(char *kval)
+static enum kind set_kind(char *kval)
 {
     if (strcmp(kval, "basic") == 0)
-        return sizeof(void *) == 8 ? BASICX64 : BASIC;
+        return IS_64_BIT ? BASICX64 : BASIC;
     else if (strcmp(kval, "banana") == 0)
-        return sizeof(void *) == 8 ? BANANAX64 : BANANA;
+        return IS_64_BIT ? BANANAX64 : BANANA;
     else if (strcmp(kval, "potato") == 0)
-        return sizeof(void *) == 8 ? POTATOX64 : POTATO;
+        return IS_64_BIT ? POTATOX64 : POTATO;
     else
         return UNKNOWN;
 }
@@ -230,41 +255,48 @@ enum kind set_kind(char *kval)
  * Each line is passed to parse_input()
  *
  * @param vmr Pointer to the iVMR interface
+ * @param with_prompt If true, prints the interactive prompt '>>'
  */
-void interactive(PT_VMR vmr)
+static void interactive(PT_VMR vmr, bool with_prompt)
 {
     char input[MAX_LINE];
+    size_t len;
 
-    printf(">> ");
+    if (with_prompt)
+        printf(">> ");
     while (fgets(input, MAX_LINE, stdin) != NULL)
     {
-        input[strcspn(input, "\n")] = 0;
+        input[(len = strcspn(input, "\n"))] = 0;
-        if (strlen(input) == 1 && toupper(input[0]) == 'Q')
+        if (len == 1 && toupper(input[0]) == 'Q')
             break;
 
         parse_input(vmr, input);
 
-        memset(input, 0, MAX_LINE); /* reset input buffer */
+        if (with_prompt)
-        printf(">> ");
+            printf(">> ");
     }
 }
 
 /**
- * @brief Walks through each line split by " \t;," delimiters.
+ * @brief Returns early if input is a comment
+ * Walks through each line split by " \t;," delimiters.
  * Each token is passed to parse_command()
  *
  * @param vmr Pointer to the iVMR interface
  * @param input Each input line, from stdin or CLI args
  */
-void parse_input(PT_VMR vmr, char *input)
+static void parse_input(PT_VMR vmr, char *input)
 {
+    if (is_comment(input))
+        return;
+
     char *token, *p;
 
-    token = strtok_r(input, " \t;,", &p);
+    token = strtok_r(input, DELIMITERS, &p);
     while (token != NULL)
     {
         parse_command(vmr, token);
-        token = strtok_r(NULL, " \t;,", &p);
+        token = strtok_r(NULL, DELIMITERS, &p);
     }
 }
 
@@ -276,10 +308,28 @@ void parse_input(PT_VMR vmr, char *input)
  * @param vmr Pointer to the iVMR interface
  * @param command Each token from the input line as its own command string
  */
-void parse_command(PT_VMR vmr, char *command)
+static void parse_command(PT_VMR vmr, char *command)
 {
     log_debug("Parsing %s", command);
 
+    static const struct quickcommand quickcommands[] = {
+        {.name = "lock", .fullcommand = "command.lock=1"},
+        {.name = "unlock", .fullcommand = "command.lock=0"},
+        {.name = "show", .fullcommand = "command.show=1"},
+        {.name = "hide", .fullcommand = "command.show=0"},
+        {.name = "restart", .fullcommand = "command.restart=1"}};
+
+    struct quickcommand *qc_ptr = command_in_quickcommands(command, quickcommands, (int)COUNT_OF(quickcommands));
+    if (qc_ptr != NULL)
+    {
+        set_parameters(vmr, qc_ptr->fullcommand);
+        if (vflag)
+        {
+            printf("Setting %s\n", qc_ptr->fullcommand);
+        }
+        return;
+    }
+
     if (command[0] == '!') /* toggle */
     {
         command++;
@@ -336,11 +386,11 @@ void parse_command(PT_VMR vmr, char *command)
  *
  * @param vmr Pointer to the iVMR interface
  * @param command A parsed 'get' command as a string
- * @param res A struct holding the result of the API call.
+ * @param res Pointer to a struct holding the result of the API call.
  */
-void get(PT_VMR vmr, char *command, struct result *res)
+static void get(PT_VMR vmr, char *command, struct result *res)
 {
-    clear_dirty(vmr);
+    clear(vmr, is_pdirty);
     if (get_parameter_float(vmr, command, &res->val.f) != 0)
     {
         res->type = STRING_T;

src/wrapper.c

@@ -2,7 +2,7 @@
  * @file wrapper.c
  * @author Onyx and Iris (code@onyxandiris.online)
  * @brief Provides public functions that wrap the iVMR calls
- * @version 0.7.0
+ * @version 0.11.0
  * @date 2024-07-06
  *
  * @copyright Copyright (c) 2024
@@ -10,14 +10,13 @@
  */
 
 #include <windows.h>
-#include <stdio.h>
-#include <time.h>
 #include "wrapper.h"
 #include "log.h"
 #include "util.h"
 
 #define KIND_STR_LEN 64
 #define VERSION_STR_LEN 32
+#define LOGIN_TIMEOUT 2
 
 /**
  * @brief Logs into the API.
@@ -26,11 +25,13 @@
  *
  * @param vmr Pointer to the iVMR interface
  * @param kind The kind of Voicemeeter Gui to launch.
- * @return long VBVMR_Login return value
+ * @return long
+ *  0: OK (no error).
+ * -2: Login timed out.
  */
 long login(PT_VMR vmr, int kind)
 {
-    int rep;
+    long rep;
     long v;
 
     log_trace("VBVMR_Login()");
@@ -44,7 +45,6 @@ long login(PT_VMR vmr, int kind)
             kind_as_string(kind_s, kind, KIND_STR_LEN));
     }
 
-    int timeout = 2;
     time_t start = time(NULL);
     do
     {
@@ -54,15 +54,12 @@ long login(PT_VMR vmr, int kind)
             log_info(
                 "Successfully logged into the Voicemeeter API v%s",
                 version_as_string(version_s, v, VERSION_STR_LEN));
+            clear(vmr, is_pdirty);
             break;
         }
         Sleep(50);
-    } while (time(NULL) < start + timeout);
+    } while (difftime(time(NULL), start) < LOGIN_TIMEOUT);
 
-    if (rep == 0)
-    {
-        clear_dirty(vmr);
-    }
     return rep;
 }
 
@@ -71,95 +68,201 @@ long login(PT_VMR vmr, int kind)
  * final instruction to complete.
  *
  * @param vmr Pointer to the iVMR interface
- * @return long VBVMR_Logout return value
+ * @return long See:
+ * https://github.com/onyx-and-iris/vmrcli/blob/main/include/VoicemeeterRemote.h#L56
  */
 long logout(PT_VMR vmr)
 {
-    int rep;
-
     Sleep(20); /* give time for last command */
     log_trace("VBVMR_Logout()");
-    rep = vmr->VBVMR_Logout();
+    return vmr->VBVMR_Logout();
-    if (rep == 0)
-        log_info("Successfully logged out of the Voicemeeter API");
-    return rep;
 }
 
+/**
+ * @brief Launches Voicemeeter or other utility apps
+ *
+ * @param vmr Pointer to the iVMR interface
+ * @param kind The kind of app to launch
+ * @return long See:
+ * https://github.com/onyx-and-iris/vmrcli/blob/main/include/VoicemeeterRemote.h#L66
+ */
 long run_voicemeeter(PT_VMR vmr, int kind)
 {
     log_trace("VBVMR_RunVoicemeeter(%d)", kind);
     return vmr->VBVMR_RunVoicemeeter((long)kind);
 }
 
+/**
+ * @brief Get Voicemeeter type
+ *
+ * @param vmr Pointer to the iVMR interface
+ * @param type Pointer to a long object receiving the type
+ * @return long See:
+ * https://github.com/onyx-and-iris/vmrcli/blob/main/include/VoicemeeterRemote.h#L107
+ */
 long type(PT_VMR vmr, long *type)
 {
     log_trace("VBVMR_GetVoicemeeterType(<long> *t)");
     return vmr->VBVMR_GetVoicemeeterType(type);
 }
 
+/**
+ * @brief Get Voicemeeter version
+ *
+ * @param vmr Pointer to the iVMR interface
+ * @param version Pointer to a long object receiving the version
+ * @return long See:
+ * https://github.com/onyx-and-iris/vmrcli/blob/main/include/VoicemeeterRemote.h#L122
+ */
 long version(PT_VMR vmr, long *version)
 {
     log_trace("VBVMR_GetVoicemeeterVersion(<long> *v)");
     return vmr->VBVMR_GetVoicemeeterVersion(version);
 }
 
+/**
+ * @brief Polling function, use it to determine if there are parameter
+ * states to be updated.
+ *
+ * @param vmr Pointer to the iVMR interface
+ * @return true New parameters yet to be updated
+ * @return false No new parameters, safe to make a get call
+ */
 bool is_pdirty(PT_VMR vmr)
 {
     log_trace("VBVMR_IsParametersDirty()");
     return vmr->VBVMR_IsParametersDirty() == 1;
 }
 
+/**
+ * @brief Get the parameter float object
+ *
+ * @param vmr Pointer to the iVMR interface
+ * @param param The parameter to be queried
+ * @param f Pointer to a float object receiving the value
+ * @return long See:
+ * https://github.com/onyx-and-iris/vmrcli/blob/main/include/VoicemeeterRemote.h#L159
+ */
 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(PT_VMR vmr, char *param, unsigned short *s)
+/**
+ * @brief Get the parameter string object
+ *
+ * @param vmr Pointer to the iVMR interface
+ * @param param The parameter to be queried
+ * @param s Pointer to a character buffer receiving the string value
+ * @return long See:
+ * https://github.com/onyx-and-iris/vmrcli/blob/main/include/VoicemeeterRemote.h#L173
+ */
+long get_parameter_string(PT_VMR vmr, char *param, wchar_t *s)
 {
-    log_trace("VBVMR_GetParameterStringW(%s, <unsigned short> *s)", param);
+    log_trace("VBVMR_GetParameterStringW(%s, <wchar_t> *s)", param);
     return vmr->VBVMR_GetParameterStringW(param, s);
 }
 
+/**
+ * @brief Set the parameter float object
+ *
+ * @param vmr Pointer to the iVMR interface
+ * @param param The parameter to be updated
+ * @param val The new value
+ * @return long See:
+ * https://github.com/onyx-and-iris/vmrcli/blob/main/include/VoicemeeterRemote.h#L309
+ */
 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);
 }
 
+/**
+ * @brief Set the parameter string object
+ *
+ * @param vmr Pointer to the iVMR interface
+ * @param param The parameter to be updated
+ * @param s Pointer to a char[] object containing the new value
+ * @return long See:
+ * https://github.com/onyx-and-iris/vmrcli/blob/main/include/VoicemeeterRemote.h#L327
+ */
 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);
 }
 
+/**
+ * @brief Run a script possibly containing multiple instructions
+ *
+ * @param vmr Pointer to the iVMR interface
+ * @param command Pointer to a char[] object containing the script
+ * @return long See:
+ * https://github.com/onyx-and-iris/vmrcli/blob/main/include/VoicemeeterRemote.h#L351
+ */
 long set_parameters(PT_VMR vmr, char *command)
 {
     log_trace("VBVMR_SetParameters(%s)", command);
     return vmr->VBVMR_SetParameters(command);
 }
 
+/**
+ * @brief Polling function, use it to determine if there are macrobutton
+ * states to be updated.
+ *
+ * @param vmr Pointer to the iVMR interface
+ * @return true Macrobutton states yet to be udpated
+ * @return false No new macrobutton states
+ */
 bool is_mdirty(PT_VMR vmr)
 {
     log_trace("VBVMR_MacroButton_IsDirty()");
-    return vmr->VBVMR_MacroButton_IsDirty() == 1;
+    return vmr->VBVMR_MacroButton_IsDirty() >= 0;
 }
 
+/**
+ * @brief Get the current status of macrobutton[n].{mode}
+ *
+ * @param vmr Pointer to the iVMR interface
+ * @param n Index of the macrobutton
+ * @param val Pointer to a float object the current value will be stored in
+ * @param mode The mode (stateonly, state, trigger)
+ * @return long See:
+ * https://github.com/onyx-and-iris/vmrcli/blob/main/include/VoicemeeterRemote.h#L663
+ */
 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);
 }
 
+/**
+ * @brief Set the current status of macrobutton[n].{mode}
+ *
+ * @param vmr Pointer to the iVMR interface
+ * @param n Index of the macrobutton
+ * @param val Value to be updated
+ * @param mode The mode (stateonly, state, trigger)
+ * @return long See:
+ * https://github.com/onyx-and-iris/vmrcli/blob/main/include/VoicemeeterRemote.h#L677
+ */
 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(PT_VMR vmr)
+/**
+ * @brief Continuously polls an is_{}dirty function until it clears.
+ *
+ * @param vmr Pointer to the iVMR interface
+ * @param f Pointer to a polling function
+ */
+void clear(PT_VMR vmr, bool (*f)(PT_VMR))
 {
     Sleep(30);
-    while (is_pdirty(vmr))
+    while (f(vmr))
         Sleep(1);
-}
+}