protect against unsafe gain changes

log message updated to reflect new kinds

replace_multiple_space_with_one() now returns new line length

kind_as_string() added to util.c

README.md

@@ -12,11 +12,14 @@
 
 ## `Use`
 
-`./vmrcli.exe [-i] [-k] [-D] <api commands>`
+```powershell
+./vmrcli.exe [-h] [-i] [-k] [-D] <api commands>
+```
 
 Where:
 
-- `i`: Enable interactive mode. If set any api commands passed will be ignored.
+- `h`: Prints the help dialogue.
+- `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
 
@@ -28,22 +31,55 @@ Where:
 
 Examples:
 
-Launch basic GUI, set debug level to INFO, Toggle Strip 0 Mute, then print its new value
+Launch basic GUI, set log level to INFO, Toggle Strip 0 Mute, then print its new value
 
-`./vmrcli.exe -kbasic -D2 !strip[0].mute strip[0].mute`
+```powershell
+./vmrcli.exe -kbasic -D2 !strip[0].mute strip[0].mute
+```
 
-Launch banana GUI, set debug level to DEBUG, set Strip 0 label to podmic then print Strip 2 label
+Launch banana GUI, set log level to DEBUG, set Strip 0 label to podmic then print Strip 2 label
 
-`vmrcli.exe -kbanana -D1 strip[0].label=podmic strip[2].label`
+```powershell
+./vmrcli.exe -kbanana -D1 strip[0].label=podmic strip[2].label
+```
+
+## `Interactive Mode`
+
+Running the following command in Powershell:
+
+```powershell
+./vmrcli.exe -i
+```
+
+Will open an interactive prompt:
+
+```powershell
+Interactive mode enabled. Enter 'Q' to exit.
+>>
+```
+
+API commands follow the same rules as listed above. Entering `Q` or `q` will exit the program.
 
 ## `Script files`
 
-Scripts can be loaded from text files, for example:
+Scripts can be loaded from text files, for example in Powershell:
 
 ```powershell
-./vbantxt-cli -D1 $(Get-Content .\example_commands.txt)
+./vmrcli.exe -D1 $(Get-Content .\example_commands.txt)
 ```
 
+## `Build`
+
+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:
+
+`make LOG_USE_COLOR=no`
+
+## `Official Documentation`
+
+- [Voicemeeter Remote C API](https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/main/VoicemeeterRemoteAPI.pdf)
+
 ## `Special Thanks`
 
 - [rxi](https://github.com/rxi) for writing the [log.c](https://github.com/rxi/log.c) package

include/cdll.h

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

include/util.h

@@ -0,0 +1,9 @@
+#ifndef __UTIL_H__
+#define __UTIL_H__
+
+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 *version_as_string(char *, long v, int n);
+
+#endif /* __UTIL_H__ */

include/vmr.h

@@ -1,15 +1,17 @@
-#include <stdbool.h>
-#include "voicemeeterRemote.h"
-
 #ifndef __VMR_H__
 #define __VMR_H__
 
+#include <stdbool.h>
+#include "voicemeeterRemote.h"
+
 enum kind
 {
     BASIC = 1,
     BANANA,
     POTATO,
-    POTATOX64 = 6
+    BASICX64,
+    BANANAX64,
+    POTATOX64,
 };
 
 long login(T_VBVMR_INTERFACE *iVMR, int kind);
@@ -20,7 +22,7 @@ long version(T_VBVMR_INTERFACE *iVMR, long *version);
 
 bool is_pdirty(T_VBVMR_INTERFACE *iVMR);
 long get_parameter_float(T_VBVMR_INTERFACE *iVMR, char *param, float *f);
-long get_parameter_string(T_VBVMR_INTERFACE *iVMR, char *param, char *s);
+long get_parameter_string(T_VBVMR_INTERFACE *iVMR, char *param, unsigned short *s);
 long set_parameter_float(T_VBVMR_INTERFACE *iVMR, char *param, float val);
 long set_parameter_string(T_VBVMR_INTERFACE *iVMR, char *param, char *s);
 long set_parameters(T_VBVMR_INTERFACE *iVMR, char *command);

makefile

@@ -9,7 +9,12 @@ EXE := $(BIN_DIR)/$(program).exe
 SRC := $(wildcard $(SRC_DIR)/*.c)
 OBJ := $(SRC:$(SRC_DIR)/%.c=$(OBJ_DIR)/%.o)
 
+LOG_USE_COLOR ?= yes
+ifeq ($(LOG_USE_COLOR), yes)
+	CPPFLAGS := -Iinclude -MMD -MP -DLOG_USE_COLOR
+else
 	CPPFLAGS := -Iinclude -MMD -MP
+endif
 CFLAGS = -O -Wall -W -pedantic -ansi -std=c99
 LDFLAGS  := -Llib
 LDLIBS   := -lm
@@ -28,7 +33,6 @@ $(BIN_DIR) $(OBJ_DIR):
 	pwsh -Command New-Item -Path $@ -ItemType Directory
 
 clean:
-	pwsh -Command Remove-Item -Recurse $(EXE)
-	pwsh -Command Remove-Item -Recurse $(OBJ_DIR)
+	pwsh -Command Remove-Item -Recurse $(EXE), $(OBJ_DIR)
 
 -include $(OBJ:.o=.d)

src/cdll.c

@@ -1,6 +1,7 @@
 #include <stdbool.h>
 #include <stdio.h>
 #include "cdll.h"
+#include "util.h"
 
 /*******************************************************************************/
 /**                           GET VOICEMEETER DIRECTORY                       **/
@@ -12,18 +13,6 @@
 #define KEY_WOW64_32KEY 0x0200
 #endif
 
-void remove_name_in_path(char *szPath)
-{
-    char *p = szPath;
-
-    while (*p++)
-        ;
-    while (p > szPath && *p != '\\')
-        p--;
-    if (*p == '\\')
-        *p = '\0';
-}
-
 bool __cdecl registry_get_voicemeeter_folder(char *szDir)
 {
     char szKey[256];

src/util.c

@@ -0,0 +1,90 @@
+#include <stddef.h>
+#include <stdio.h>
+#include "vmr.h"
+#include "util.h"
+
+void remove_name_in_path(char *szPath)
+{
+    char *p = szPath;
+
+    while (*p++)
+        ;
+    while (p > szPath && *p != '\\')
+        p--;
+    if (*p == '\\')
+        *p = '\0';
+}
+
+/**
+ * @brief replaces multiple newlines and tabs with single spaces
+ *
+ * @param s the string to be reduced
+ * @param len current length of the string
+ * @return int new length of the string
+ */
+int replace_multiple_space_with_one(char *s, size_t len)
+{
+    int j = 0;
+    int count = 0;
+
+    if (len == 1 && (s[0] == ' ' || s[0] == '\t'))
+    {
+        s[0] = '\0';
+        return len;
+    }
+
+    if (len < 2)
+        return len;
+
+    for (int i = 0; s[i] != '\0'; i++)
+    {
+        if (s[i] == ' ' || s[i] == '\t')
+        {
+            count++;
+        }
+
+        if (s[i] != ' ' && s[i] != '\t')
+        {
+            if (count >= 1)
+            {
+                count = 0;
+                s[j++] = ' ';
+            }
+            s[j++] = s[i];
+        }
+    }
+    s[j] = '\0';
+    return j;
+}
+
+char *kind_as_string(char *s, enum kind kind, int n)
+{
+    char *kinds[] = {
+        "Basic",
+        "Banana",
+        "Potato",
+        "Basic x64",
+        "Banana x64",
+        "Potato x64",
+    };
+    snprintf(s, n, kinds[kind - 1]);
+    return s;
+}
+
+/**
+ * @brief returns Voicemeeter's version as a string
+ *
+ * @param s string buffer the version will be written to
+ * @param v unprocessed version as a long int
+ * @param n maximum number of characters to be written to the buffer
+ * @return char*
+ */
+char *version_as_string(char *s, long v, int n)
+{
+    long v1 = (v & 0xFF000000) >> 24,
+         v2 = (v & 0x00FF0000) >> 16,
+         v3 = (v & 0x0000FF00) >> 8,
+         v4 = (v & 0x000000FF);
+    snprintf(s, n, "%i.%i.%i.%i", (int)v1, (int)v2, (int)v3, (int)v4);
+    return s;
+}

src/vmr.c

@@ -1,117 +1,133 @@
 #include <windows.h>
 #include <stdio.h>
+#include <time.h>
 #include "vmr.h"
 #include "log.h"
+#include "util.h"
 
-long login(T_VBVMR_INTERFACE *iVMR, int kind)
+#define VERSION_STR_LEN 128
+#define KIND_STR_LEN 64
+
+long login(T_VBVMR_INTERFACE *vmr, int kind)
 {
     int rep;
+    long v;
 
-    rep = iVMR->VBVMR_Login();
-    Sleep(20);
+    rep = vmr->VBVMR_Login();
     if (rep == 1)
     {
-        rep = run_voicemeeter(iVMR, kind);
-        switch (kind)
-        {
-        case BASIC:
-            log_info("Launching Voicemeeter Basic GUI");
-            break;
-        case BANANA:
-            log_info("Launching Voicemeeter Banana GUI");
-            break;
-        case POTATO:
-            log_info("Launching Voicemeeter Potato GUI");
-            break;
-        case POTATOX64:
-            log_info("Launching Voicemeeter Potato x64 GUI");
-            break;
-        }
+        run_voicemeeter(vmr, kind);
+        char kind_s[KIND_STR_LEN];
+        log_info(
+            "Launching Voicemeeter %s GUI",
+            kind_as_string(kind_s, kind, KIND_STR_LEN));
 
-        Sleep(1200);
+        time_t endwait;
+        int timeout = 2;
+
+        endwait = time(NULL) + timeout;
+        do
+        {
+            if ((rep = version(vmr, &v)) == 0)
+                break;
+            Sleep(50);
+        } while (time(NULL) < endwait);
     }
     if (rep == 0)
     {
-        log_info("Successfully logged into the Voicemeeter API");
-        clear_dirty(iVMR);
+        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 *iVMR)
+long logout(T_VBVMR_INTERFACE *vmr)
 {
     int rep;
 
     Sleep(20); /* give time for last command */
-    rep = iVMR->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 *iVMR, int kind)
+long run_voicemeeter(T_VBVMR_INTERFACE *vmr, int kind)
 {
-    return iVMR->VBVMR_RunVoicemeeter((long)kind);
+    log_trace("VBVMR_RunVoicemeeter(%d)", kind);
+    return vmr->VBVMR_RunVoicemeeter((long)kind);
 }
 
-long type(T_VBVMR_INTERFACE *iVMR, long *type)
+long type(T_VBVMR_INTERFACE *vmr, long *type)
 {
-    return iVMR->VBVMR_GetVoicemeeterType(type);
+    log_trace("VBVMR_GetVoicemeeterType(<long> *t)");
+    return vmr->VBVMR_GetVoicemeeterType(type);
 }
 
-long version(T_VBVMR_INTERFACE *iVMR, long *version)
+long version(T_VBVMR_INTERFACE *vmr, long *version)
 {
-    return iVMR->VBVMR_GetVoicemeeterType(version);
+    log_trace("VBVMR_GetVoicemeeterVersion(<long> *v)");
+    return vmr->VBVMR_GetVoicemeeterVersion(version);
 }
 
-bool is_pdirty(T_VBVMR_INTERFACE *iVMR)
+bool is_pdirty(T_VBVMR_INTERFACE *vmr)
 {
-    return iVMR->VBVMR_IsParametersDirty() == 1;
+    log_trace("VBVMR_IsParametersDirty()");
+    return vmr->VBVMR_IsParametersDirty() == 1;
 }
 
-long get_parameter_float(T_VBVMR_INTERFACE *iVMR, char *param, float *f)
+long get_parameter_float(T_VBVMR_INTERFACE *vmr, char *param, float *f)
 {
-    return iVMR->VBVMR_GetParameterFloat(param, f);
+    log_trace("VBVMR_GetParameterFloat(%s, <float> *f)", param);
+    return vmr->VBVMR_GetParameterFloat(param, f);
 }
 
-long get_parameter_string(T_VBVMR_INTERFACE *iVMR, char *param, char *s)
+long get_parameter_string(T_VBVMR_INTERFACE *vmr, char *param, unsigned short *s)
 {
-    return iVMR->VBVMR_GetParameterStringA(param, s);
+    log_trace("VBVMR_GetParameterStringW(%s, <unsigned short> *s)", param);
+    return vmr->VBVMR_GetParameterStringW(param, s);
 }
 
-long set_parameter_float(T_VBVMR_INTERFACE *iVMR, char *param, float val)
+long set_parameter_float(T_VBVMR_INTERFACE *vmr, char *param, float val)
 {
-    return iVMR->VBVMR_SetParameterFloat(param, val);
+    log_trace("VBVMR_SetParameterFloat(%s, %.1f)", param, val);
+    return vmr->VBVMR_SetParameterFloat(param, val);
 }
 
-long set_parameter_string(T_VBVMR_INTERFACE *iVMR, char *param, char *s)
+long set_parameter_string(T_VBVMR_INTERFACE *vmr, char *param, char *s)
 {
-    return iVMR->VBVMR_SetParameterStringA(param, s);
+    log_trace("VBVMR_SetParameterStringA(%s, %s)", param, s);
+    return vmr->VBVMR_SetParameterStringA(param, s);
 }
 
-long set_parameters(T_VBVMR_INTERFACE *iVMR, char *command)
+long set_parameters(T_VBVMR_INTERFACE *vmr, char *command)
 {
-    return iVMR->VBVMR_SetParameters(command);
+    log_trace("VBVMR_SetParameters(%s)", command);
+    return vmr->VBVMR_SetParameters(command);
 }
 
-bool is_mdirty(T_VBVMR_INTERFACE *iVMR)
+bool is_mdirty(T_VBVMR_INTERFACE *vmr)
 {
-    return iVMR->VBVMR_MacroButton_IsDirty() == 1;
+    return vmr->VBVMR_MacroButton_IsDirty() == 1;
 }
 
-long macrobutton_getstatus(T_VBVMR_INTERFACE *iVMR, long n, float *val, long mode)
+long macrobutton_getstatus(T_VBVMR_INTERFACE *vmr, long n, float *val, long mode)
 {
-    return iVMR->VBVMR_MacroButton_GetStatus(n, val, mode);
+    return vmr->VBVMR_MacroButton_GetStatus(n, val, mode);
 }
 
-long macrobutton_setstatus(T_VBVMR_INTERFACE *iVMR, long n, float val, long mode)
+long macrobutton_setstatus(T_VBVMR_INTERFACE *vmr, long n, float val, long mode)
 {
-    return iVMR->VBVMR_MacroButton_SetStatus(n, val, mode);
+    return vmr->VBVMR_MacroButton_SetStatus(n, val, mode);
 }
 
-void clear_dirty(T_VBVMR_INTERFACE *iVMR)
+void clear_dirty(T_VBVMR_INTERFACE *vmr)
 {
     Sleep(30);
-    while (is_pdirty(iVMR))
+    while (is_pdirty(vmr))
         Sleep(1);
 }

src/vmrcli.c

@@ -5,6 +5,7 @@
 #include "cdll.h"
 #include "vmr.h"
 #include "log.h"
+#include "util.h"
 
 #define MAX_LINE 512
 
@@ -20,16 +21,16 @@ struct result
     union val
     {
         float f;
-        char s[MAX_LINE];
+        wchar_t s[MAX_LINE];
     } val;
 };
 
 void help(void);
-int set_kind(char *kval);
+enum kind set_kind(char *kval);
 int init_voicemeeter(T_VBVMR_INTERFACE *vmr, int kind);
 void interactive(T_VBVMR_INTERFACE *vmr);
 void parse_command(T_VBVMR_INTERFACE *vmr, char *command);
-struct result *get(T_VBVMR_INTERFACE *vmr, char *command, struct result *res);
+void get(T_VBVMR_INTERFACE *vmr, char *command, struct result *res);
 
 int main(int argc, char *argv[])
 {
@@ -37,15 +38,15 @@ int main(int argc, char *argv[])
     int opt;
     char *kvalue = "";
     int dvalue;
-    int kind = BANANA;
+    enum kind kind = BANANAX64;
 
     if (argc == 1)
     {
         help();
-        return EXIT_SUCCESS;
+        exit(EXIT_SUCCESS);
     }
 
-    log_set_level(LOG_INFO);
+    log_set_level(LOG_WARN);
 
     while ((opt = getopt(argc, argv, "k:ihD:")) != -1)
     {
@@ -62,10 +63,17 @@ int main(int argc, char *argv[])
             help();
             exit(EXIT_SUCCESS);
         case 'D':
-            if ((dvalue = atoi(optarg)) && dvalue >= LOG_TRACE && dvalue <= LOG_FATAL)
+            dvalue = atoi(optarg);
+            if (dvalue >= LOG_TRACE && dvalue <= LOG_FATAL)
             {
                 log_set_level(dvalue);
             }
+            else
+            {
+                log_error(
+                    "-D arg out of range, expected value from 0 up to 5\n"
+                    "Log level will default to LOG_WARN (3).\n");
+            }
             break;
         default:
             abort();
@@ -101,24 +109,41 @@ int main(int argc, char *argv[])
         return EXIT_FAILURE;
 }
 
+/**
+ * @brief prints the help dialogue
+ *
+ */
 void help()
 {
     puts(
-        "Usage: ./vmrcli.exe [-i] [-k] <api commands>\n"
+        "Usage: ./vmrcli.exe [-h] [-i] [-k] [-D] <api commands>\n"
         "Where: \n"
+        "\th: Prints the help dialogue\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");
 }
 
-int set_kind(char *kval)
+/**
+ * @brief Set the kind object
+ *
+ * @param kval
+ * @return enum kind
+ */
+enum kind set_kind(char *kval)
 {
     if (strcmp(kval, "basic") == 0)
     {
+        if (sizeof(void *) == 8)
+            return BASICX64;
+        else
             return BASIC;
     }
     else if (strcmp(kval, "banana") == 0)
     {
+        if (sizeof(void *) == 8)
+            return BANANAX64;
+        else
             return BANANA;
     }
     else if (strcmp(kval, "potato") == 0)
@@ -130,7 +155,7 @@ int set_kind(char *kval)
     }
     else
     {
-        fprintf(stderr, "Unknown Voicemeeter kind '%s'\n", kval);
+        log_error("Unknown Voicemeeter kind '%s'\n", kval);
         exit(EXIT_FAILURE);
     }
 }
@@ -142,11 +167,11 @@ int init_voicemeeter(T_VBVMR_INTERFACE *vmr, int kind)
     {
         if (rep == -100)
         {
-            fputs("Voicemeeter is not installed", stderr);
+            log_error("Voicemeeter is not installed");
         }
         else
         {
-            fprintf(stderr, "Error loading Voicemeeter dll with code %d\n", rep);
+            log_error("Error loading Voicemeeter dll with code %d\n", rep);
         }
         return rep;
     }
@@ -154,7 +179,7 @@ int init_voicemeeter(T_VBVMR_INTERFACE *vmr, int kind)
     rep = login(vmr, kind);
     if (rep != 0)
     {
-        fputs("Error logging into Voicemeeter", stderr);
+        log_error("Error logging into Voicemeeter");
         return rep;
     }
 
@@ -163,29 +188,43 @@ int init_voicemeeter(T_VBVMR_INTERFACE *vmr, int kind)
 
 void interactive(T_VBVMR_INTERFACE *vmr)
 {
-    char input[MAX_LINE];
+    char input[MAX_LINE], command[MAX_LINE];
     char *p = input;
+    int i;
+    size_t len;
 
+    printf(">> ");
     while (fgets(input, MAX_LINE, stdin) != NULL)
     {
         input[strcspn(input, "\n")] = 0;
-        if (strlen(input) == 1 && (strncmp(input, "Q", 1) == 0 || strncmp(input, "q", 1) == 0))
+        len = strlen(input);
+        if (len == 1 && toupper(input[0]) == 'Q')
             break;
 
+        replace_multiple_space_with_one(input, len);
         while (*p)
         {
-            char command[MAX_LINE];
-            int i = 0;
+            if (isspace(*p))
+            {
+                p++;
+                continue;
+            }
+            log_trace("commands still in buffer: %s", p);
 
-            while (!isspace(*p) && *p != EOF)
+            i = 0;
+            while (*p && !isspace(*p))
                 command[i++] = *p++;
             command[i] = '\0';
             p++; /* shift to next char */
 
+            if (command[0] != '\0')
                 parse_command(vmr, command);
+            memset(command, '\0', MAX_LINE);
         }
 
         p = input;                     /* reset pointer */
+        memset(input, '\0', MAX_LINE); /* reset input buffer */
+        printf(">> ");
     }
 }
 
@@ -201,7 +240,10 @@ void parse_command(T_VBVMR_INTERFACE *vmr, char *command)
         get(vmr, command, &res);
         if (res.type == FLOAT_T)
         {
+            if (res.val.f == 1 || res.val.f == 0)
                 set_parameter_float(vmr, command, 1 - res.val.f);
+            else
+                log_warn("%s does not appear to be a boolean parameter", command);
         }
         return;
     }
@@ -218,19 +260,18 @@ void parse_command(T_VBVMR_INTERFACE *vmr, char *command)
         switch (res.type)
         {
         case FLOAT_T:
-            printf("%.2f\n", res.val.f);
+            printf("%.1f\n", res.val.f);
             break;
         case STRING_T:
-            puts(res.val.s);
+            printf("%ls\n", res.val.s);
             break;
         default:
-            fputs("Unknown result...", stderr);
             break;
         }
     }
 }
 
-struct result *get(T_VBVMR_INTERFACE *vmr, char *command, struct result *res)
+void get(T_VBVMR_INTERFACE *vmr, char *command, struct result *res)
 {
     clear_dirty(vmr);
     if (get_parameter_float(vmr, command, &res->val.f) != 0)
@@ -239,9 +280,7 @@ struct result *get(T_VBVMR_INTERFACE *vmr, char *command, struct result *res)
         if (get_parameter_string(vmr, command, res->val.s) != 0)
         {
             res->val.s[0] = 0;
-            fputs("Unknown parameter", stderr);
+            log_error("Unknown parameter '%s'", command);
         }
     }
-
-    return res;
 }