remove workflow

gcc version
artifact path

.env

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

.gitignore

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

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 }"

include/interface.h

@@ -10,6 +10,8 @@
 
 #include "VoicemeeterRemote.h"
 
+#define IS_64_BIT sizeof(void *) == 8
+
 PT_VMR create_interface();
 
 #endif /* __IVMR_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) -force
+	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.10.0
+ * @version 0.11.0
  * @date 2024-07-06
  *
  * @copyright Vincent Burel(c)2015-2021 All Rights Reserved
@@ -14,7 +14,7 @@
  */
 
 #include <windows.h>
-#include "ivmr.h"
+#include "interface.h"
 #include "util.h"
 #include "log.h"
 
@@ -25,10 +25,8 @@
 #define PRAGMA_Pop \
     _Pragma("GCC diagnostic pop")
 
-static T_VBVMR_INTERFACE iVMR;
-
 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
@@ -38,10 +36,14 @@ static bool registry_get_voicemeeter_folder(char *szDir);
  */
 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)
@@ -52,7 +54,8 @@ PT_VMR create_interface()
         {
             log_fatal("Error loading Voicemeeter dll with code %d", rep);
         }
-        return NULL;
+        free(vmr);
+        vmr = NULL;
     }
 
     return vmr;
@@ -61,26 +64,30 @@ 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;
 
@@ -125,33 +132,33 @@ static long initialize_dll_interfaces(PT_VMR vmr)
     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;
@@ -180,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,7 +2,7 @@
  * @file util.c
  * @author Onyx and Iris (code@onyxandiris.online)
  * @brief Utility functions.
- * @version 0.10.0
+ * @version 0.11.0
  * @date 2024-07-06
  *
  * @copyright Copyright (c) 2024
@@ -92,7 +92,7 @@ bool is_comment(char *s)
  */
 struct quickcommand *command_in_quickcommands(const char *command_key, const struct quickcommand *quickcommands, int n)
 {
-    for (int i = 0; i < n; i++)
+    for (int i = 0; i < n; ++i)
     {
         if (strcmp(command_key, quickcommands[i].name) == 0)
         {

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.10.0
+ * @version 0.11.0
  * @date 2024-07-06
  *
  * @copyright Copyright (c) 2024
@@ -13,7 +13,7 @@
 #include <stdlib.h>
 #include <getopt.h>
 #include <windows.h>
-#include "ivmr.h"
+#include "interface.h"
 #include "wrapper.h"
 #include "log.h"
 #include "util.h"
@@ -60,6 +60,7 @@ struct result
 
 static bool vflag = false;
 
+static void terminate(PT_VMR vmr, char *msg);
 static void usage();
 static enum kind set_kind(char *kval);
 static void interactive(PT_VMR vmr, bool with_prompt);
@@ -158,10 +159,9 @@ int main(int argc, char *argv[])
     if (rep != 0)
     {
         if (rep == -2)
-            log_fatal("Timeout logging into the API.");
+            terminate(vmr, "Timeout logging into the API.");
         else
-            log_fatal("Eror logging into the Voicemeeter API");
+            terminate(vmr, "Error logging into the Voicemeeter API");
-        exit(EXIT_FAILURE);
     }
 
     if (mflag)
@@ -191,7 +191,7 @@ int main(int argc, char *argv[])
     }
     else
     {
-        for (int i = optind; i < argc; i++)
+        for (int i = optind; i < argc; ++i)
         {
             parse_input(vmr, argv[i]);
         }
@@ -200,14 +200,25 @@ int main(int argc, char *argv[])
     rep = logout(vmr);
     if (rep != 0)
     {
-        log_fatal("Error logging out of the Voicemeeter API");
+        terminate(vmr, "Error logging out of the Voicemeeter API");
-        return EXIT_FAILURE;
-    }
-    else
-    {
-        log_info("Successfully logged out of the Voicemeeter API");
-        return EXIT_SUCCESS;
     }
+
+    log_info("Successfully logged out of the Voicemeeter API");
+    free(vmr);
+    return EXIT_SUCCESS;
+}
+
+/**
+ * @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);
 }
 
 /**
@@ -229,11 +240,11 @@ static void usage()
 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;
 }
@@ -255,12 +266,11 @@ static void interactive(PT_VMR vmr, bool with_prompt)
         printf(">> ");
     while (fgets(input, MAX_LINE, stdin) != NULL)
     {
-        input[strcspn(input, "\n")] = 0;
+        input[(len = strcspn(input, "\n"))] = 0;
-        if ((len = strlen(input)) == 1 && toupper(input[0]) == 'Q')
+        if (len == 1 && toupper(input[0]) == 'Q')
             break;
 
         parse_input(vmr, input);
-        memset(input, 0, len); /* reset input buffer */
 
         if (with_prompt)
             printf(">> ");

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.10.0
+ * @version 0.11.0
  * @date 2024-07-06
  *
  * @copyright Copyright (c) 2024