modify example_commands to show multiple instructions per line

Add note in README about change.

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Onyx and Iris
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,4 +1,4 @@
-# VMRCLI Command Line Utility
+# Voicemeeter Remote Command Line Utility
 
 ## `Tested against`
 
@@ -12,10 +12,13 @@
 
 ## `Use`
 
-`./vmrcli.exe [-i] [-k] [-D] <api commands>`
+```powershell
+./vmrcli.exe [-h] [-i] [-k] [-D] <api commands>
+```
 
 Where:
 
+- `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
@@ -30,17 +33,23 @@ Examples:
 
 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 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:
 
-`./vmrcli.exe -i`
+```powershell
+./vmrcli.exe -i
+```
 
 Will open an interactive prompt:
 
@@ -59,9 +68,11 @@ Scripts can be loaded from text files, for example in Powershell:
 ./vmrcli.exe -D1 $(Get-Content .\example_commands.txt)
 ```
 
+Multiple API commands can be in a single line but they should be space separated.
+
 ## `Build`
 
-Run the included `makefile` to build with [GNU Make](https://www.gnu.org/software/make/).
+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:
 

example_commands.txt

@@ -1,8 +1,3 @@
-strip[0].mute 
+strip[0].mute !strip[0].mute strip[0].mute strip[0].gain strip[0].label=podmic strip[0].label
-!strip[0].mute 
+strip[1].mute=1 strip[1].mute
-strip[0].mute
+bus[0].label bus[0].gain=-8.3
-strip[1].mute=1
-strip[1].mute
-strip[0].gain
-strip[0].label=podmic
-strip[0].label

include/util.h

@@ -1,6 +1,9 @@
 #ifndef __UTIL_H__
 #define __UTIL_H__
 
-void replace_multiple_space_with_one(char *s, size_t len);
+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

@@ -9,26 +9,28 @@ enum kind
     BASIC = 1,
     BANANA,
     POTATO,
-    POTATOX64 = 6
+    BASICX64,
+    BANANAX64,
+    POTATOX64,
 };
 
-long login(T_VBVMR_INTERFACE *iVMR, int kind);
+long login(T_VBVMR_INTERFACE *vmr, int kind);
-long logout(T_VBVMR_INTERFACE *iVMR);
+long logout(T_VBVMR_INTERFACE *vmr);
-long run_voicemeeter(T_VBVMR_INTERFACE *iVMR, int kind);
+long run_voicemeeter(T_VBVMR_INTERFACE *vmr, int kind);
-long type(T_VBVMR_INTERFACE *iVMR, long *type);
+long type(T_VBVMR_INTERFACE *vmr, long *type);
-long version(T_VBVMR_INTERFACE *iVMR, long *version);
+long version(T_VBVMR_INTERFACE *vmr, long *version);
 
-bool is_pdirty(T_VBVMR_INTERFACE *iVMR);
+bool is_pdirty(T_VBVMR_INTERFACE *vmr);
-long get_parameter_float(T_VBVMR_INTERFACE *iVMR, char *param, float *f);
+long get_parameter_float(T_VBVMR_INTERFACE *vmr, char *param, float *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);
-long set_parameter_float(T_VBVMR_INTERFACE *iVMR, char *param, float val);
+long set_parameter_float(T_VBVMR_INTERFACE *vmr, char *param, float 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);
-long set_parameters(T_VBVMR_INTERFACE *iVMR, char *command);
+long set_parameters(T_VBVMR_INTERFACE *vmr, char *command);
 
-bool is_mdirty(T_VBVMR_INTERFACE *iVMR);
+bool is_mdirty(T_VBVMR_INTERFACE *vmr);
-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);
-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);
 
-void clear_dirty(T_VBVMR_INTERFACE *iVMR);
+void clear_dirty(T_VBVMR_INTERFACE *vmr);
 
-#endif
+#endif /* __VMR_H__ */

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

@@ -1,6 +1,28 @@
 #include <stddef.h>
+#include <stdio.h>
+#include "vmr.h"
+#include "util.h"
 
-void replace_multiple_space_with_one(char *s, size_t len)
+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;
@@ -8,11 +30,11 @@ void replace_multiple_space_with_one(char *s, size_t len)
     if (len == 1 && (s[0] == ' ' || s[0] == '\t'))
     {
         s[0] = '\0';
-        return;
+        return len;
     }
 
     if (len < 2)
-        return;
+        return len;
 
     for (int i = 0; s[i] != '\0'; i++)
     {
@@ -32,4 +54,37 @@ void replace_multiple_space_with_one(char *s, size_t len)
         }
     }
     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

@@ -3,6 +3,10 @@
 #include <time.h>
 #include "vmr.h"
 #include "log.h"
+#include "util.h"
+
+#define VERSION_STR_LEN 128
+#define KIND_STR_LEN 64
 
 long login(T_VBVMR_INTERFACE *vmr, int kind)
 {
@@ -13,21 +17,10 @@ long login(T_VBVMR_INTERFACE *vmr, int kind)
     if (rep == 1)
     {
         run_voicemeeter(vmr, kind);
-        switch (kind)
+        char kind_s[KIND_STR_LEN];
-        {
+        log_info(
-        case BASIC:
+            "Launching Voicemeeter %s GUI",
-            log_info("Launching Voicemeeter Basic GUI");
+            kind_as_string(kind_s, kind, KIND_STR_LEN));
-            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;
-        }
 
         time_t endwait;
         int timeout = 2;
@@ -43,13 +36,10 @@ long login(T_VBVMR_INTERFACE *vmr, int kind)
     if (rep == 0)
     {
         version(vmr, &v);
-        long v1 = (v & 0xFF000000) >> 24,
+        char version_s[VERSION_STR_LEN];
-             v2 = (v & 0x00FF0000) >> 16,
+        log_info(
-             v3 = (v & 0x0000FF00) >> 8,
+            "Successfully logged into the Voicemeeter API v%s",
-             v4 = (v & 0x000000FF);
+            version_as_string(version_s, v, VERSION_STR_LEN));
-        char version_s[128];
-        sprintf(version_s, "%i.%i.%i.%i", (int)v1, (int)v2, (int)v3, (int)v4);
-        log_info("Successfully logged into the Voicemeeter API v%s", version_s);
         clear_dirty(vmr);
     }
     return rep;
@@ -92,14 +82,14 @@ bool is_pdirty(T_VBVMR_INTERFACE *vmr)
 
 long get_parameter_float(T_VBVMR_INTERFACE *vmr, char *param, float *f)
 {
-    log_trace("VBVMR_GetParameterFloat(%s, <float> *f)", param, 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, char *s)
+long get_parameter_string(T_VBVMR_INTERFACE *vmr, char *param, unsigned short *s)
 {
-    log_trace("VBVMR_GetParameterStringA(%s, <char> *s)", param, s);
+    log_trace("VBVMR_GetParameterStringW(%s, <unsigned short> *s)", param);
-    return vmr->VBVMR_GetParameterStringA(param, s);
+    return vmr->VBVMR_GetParameterStringW(param, s);
 }
 
 long set_parameter_float(T_VBVMR_INTERFACE *vmr, char *param, float val)

src/vmrcli.c

@@ -21,24 +21,27 @@ 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_input(T_VBVMR_INTERFACE *vmr, char *input, int len);
 void parse_command(T_VBVMR_INTERFACE *vmr, char *command);
 void get(T_VBVMR_INTERFACE *vmr, char *command, struct result *res);
 
+bool vflag = false;
+
 int main(int argc, char *argv[])
 {
     bool iflag = false;
     int opt;
     char *kvalue = "";
     int dvalue;
-    int kind = BANANA;
+    enum kind kind = BANANAX64;
 
     if (argc == 1)
     {
@@ -48,7 +51,7 @@ int main(int argc, char *argv[])
 
     log_set_level(LOG_WARN);
 
-    while ((opt = getopt(argc, argv, "k:ihD:")) != -1)
+    while ((opt = getopt(argc, argv, "k:ihD:v")) != -1)
     {
         switch (opt)
         {
@@ -75,6 +78,9 @@ int main(int argc, char *argv[])
                     "Log level will default to LOG_WARN (3).\n");
             }
             break;
+        case 'v':
+            vflag = true;
+            break;
         default:
             abort();
         }
@@ -98,7 +104,7 @@ int main(int argc, char *argv[])
     {
         for (int i = optind; i < argc; i++)
         {
-            parse_command(vmr, argv[i]);
+            parse_input(vmr, argv[i], strlen(argv[i]));
         }
     }
 
@@ -109,25 +115,43 @@ int main(int argc, char *argv[])
         return EXIT_FAILURE;
 }
 
+/**
+ * @brief prints the help dialogue
+ *
+ */
 void help()
 {
     puts(
-        "Usage: ./vmrcli.exe [-i] [-k] [-D] <api commands>\n"
+        "Usage: ./vmrcli.exe [-h] [-i] [-k] [-D] [-v] <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");
+        "\tD: Set log level 0=TRACE, 1=DEBUG, 2=INFO, 3=WARN, 4=ERROR, 5=FATAL"
+        "\tv: Enable extra console output (toggle, set messages)\n");
 }
 
-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)
     {
-        return BASIC;
+        if (sizeof(void *) == 8)
+            return BASICX64;
+        else
+            return BASIC;
     }
     else if (strcmp(kval, "banana") == 0)
     {
-        return BANANA;
+        if (sizeof(void *) == 8)
+            return BANANAX64;
+        else
+            return BANANA;
     }
     else if (strcmp(kval, "potato") == 0)
     {
@@ -172,9 +196,6 @@ int init_voicemeeter(T_VBVMR_INTERFACE *vmr, int kind)
 void interactive(T_VBVMR_INTERFACE *vmr)
 {
     char input[MAX_LINE];
-    char *p = input;
-    char command[MAX_LINE];
-    int i;
     size_t len;
 
     printf(">> ");
@@ -185,32 +206,26 @@ void interactive(T_VBVMR_INTERFACE *vmr)
         if (len == 1 && toupper(input[0]) == 'Q')
             break;
 
-        replace_multiple_space_with_one(input, len);
+        parse_input(vmr, input, len);
-        while (*p)
-        {
-            if (isspace(*p))
-            {
-                p++;
-                continue;
-            }
-            i = 0;
-            log_trace("commands still in buffer: %s", p);
 
-            while (!isspace(*p))
+        memset(input, '\0', MAX_LINE); /* reset input buffer */
-                command[i++] = *p++;
-            command[i] = '\0';
-
-            if (command[0] != '\0')
-                parse_command(vmr, command);
-            memset(command, '\0', sizeof(command));
-        }
-
-        p = input;                          /* reset pointer */
-        memset(input, '\0', sizeof(input)); /* reset input buffer */
         printf(">> ");
     }
 }
 
+void parse_input(T_VBVMR_INTERFACE *vmr, char *input, int len)
+{
+    char *token;
+
+    replace_multiple_space_with_one(input, len);
+    token = strtok(input, " ");
+    while (token != NULL)
+    {
+        parse_command(vmr, token);
+        token = strtok(NULL, " ");
+    }
+}
+
 void parse_command(T_VBVMR_INTERFACE *vmr, char *command)
 {
     log_debug("Parsing %s", command);
@@ -223,7 +238,16 @@ void parse_command(T_VBVMR_INTERFACE *vmr, char *command)
         get(vmr, command, &res);
         if (res.type == FLOAT_T)
         {
-            set_parameter_float(vmr, command, 1 - res.val.f);
+            if (res.val.f == 1 || res.val.f == 0)
+            {
+                set_parameter_float(vmr, command, 1 - res.val.f);
+                if (vflag)
+                {
+                    printf("Toggling %s\n", command);
+                }
+            }
+            else
+                log_warn("%s does not appear to be a boolean parameter", command);
         }
         return;
     }
@@ -231,6 +255,10 @@ void parse_command(T_VBVMR_INTERFACE *vmr, char *command)
     if (strchr(command, '=') != NULL) /* set */
     {
         set_parameters(vmr, command);
+        if (vflag)
+        {
+            printf("Setting %s\n", command);
+        }
     }
     else /* get */
     {
@@ -240,10 +268,10 @@ void parse_command(T_VBVMR_INTERFACE *vmr, char *command)
         switch (res.type)
         {
         case FLOAT_T:
-            printf("%.1f\n", res.val.f);
+            printf("%s: %.1f\n", command, res.val.f);
             break;
         case STRING_T:
-            puts(res.val.s);
+            printf("%s: %ls\n", command, res.val.s);
             break;
         default:
             break;