move clear intil util.c

when resetting buffer, clear only bits written to

.gitignore

@@ -51,4 +51,6 @@ Module.symvers
 Mkfile.old
 dkms.conf
 
-.vscode/
+.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/).

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/util.h

@@ -8,8 +8,17 @@
 #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);
+void clear(PT_VMR vmr, bool (*f)(PT_VMR));
 
 #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,
@@ -41,6 +41,4 @@ 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);
-
 #endif /* __WRAPPER_H__ */

makefile

@@ -33,6 +33,6 @@ $(BIN_DIR) $(OBJ_DIR):
 	pwsh -Command New-Item -Path $@ -ItemType Directory
 
 clean:
-	pwsh -Command Remove-Item -Recurse $(EXE), $(OBJ_DIR)
+	pwsh -Command Remove-Item -Recurse $(EXE), $(OBJ_DIR) -force
 
 -include $(OBJ:.o=.d)

src/ivmr.c

@@ -3,7 +3,7 @@
  * @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.9.0
  * @date 2024-07-06
  *
  * @copyright Vincent Burel(c)2015-2021 All Rights Reserved
@@ -20,6 +20,13 @@
 #include "util.h"
 #include "log.h"
 
+#define PRAGMA_IgnoreWCastIncompatibleFuncTypes \
+    _Pragma("GCC diagnostic push")              \
+        _Pragma("GCC diagnostic ignored \"-Wcast-function-type\"")
+
+#define PRAGMA_Pop \
+    _Pragma("GCC diagnostic pop")
+
 static T_VBVMR_INTERFACE iVMR;
 
 static long initialize_dll_interfaces(PT_VMR vmr);
@@ -79,6 +86,8 @@ static long initialize_dll_interfaces(PT_VMR vmr)
     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,6 +119,8 @@ 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;

src/util.c

@@ -2,7 +2,7 @@
  * @file util.c
  * @author Onyx and Iris (code@onyxandiris.online)
  * @brief Utility functions.
- * @version 0.7.0
+ * @version 0.9.0
  * @date 2024-07-06
  *
  * @copyright Copyright (c) 2024
@@ -13,6 +13,7 @@
 #include <stdio.h>
 #include <string.h>
 #include <ctype.h>
+#include <windows.h>
 #include "wrapper.h"
 #include "util.h"
 
@@ -69,4 +70,51 @@ 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;
+}
+
+/**
+ * @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 (f(vmr))
+        Sleep(1);
 }

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.9.0
  * @date 2024-07-06
  *
  * @copyright Copyright (c) 2024
@@ -21,23 +21,26 @@
 #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,
@@ -48,19 +51,19 @@ enum
  */
 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 usage();
 enum kind set_kind(char *kval);
-void interactive(PT_VMR vmr);
+void interactive(PT_VMR vmr, bool with_prompt);
 void parse_input(PT_VMR vmr, char *input);
 void parse_command(PT_VMR vmr, char *command);
 void get(PT_VMR vmr, char *command, struct result *res);
@@ -70,7 +73,8 @@ 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;
@@ -126,14 +133,14 @@ int main(int argc, char *argv[])
             vflag = true;
             break;
         case '?':
-            log_warn("unknown option -- '%c'\n"
+            log_fatal("unknown option -- '%c'\n"
-                     "Try .\\vmrcli.exe -h for more information.",
+                      "Try .\\vmrcli.exe -h for more information.",
-                     optopt);
+                      optopt);
             exit(EXIT_FAILURE);
         case ':':
-            log_warn("missing argument for option -- '%c'\n"
+            log_fatal("missing argument for option -- '%c'\n"
-                     "Try .\\vmrcli.exe -h for more information.",
+                      "Try .\\vmrcli.exe -h for more information.",
-                     optopt);
+                      optopt);
             exit(EXIT_FAILURE);
         case 'h':
             [[fallthrough]];
@@ -144,7 +151,7 @@ int main(int argc, char *argv[])
 
     PT_VMR vmr = create_interface();
 
-    int rep = login(vmr, kind);
+    long rep = login(vmr, kind);
     if (rep != 0)
     {
         log_fatal("Error logging into the Voicemeeter API");
@@ -168,13 +175,13 @@ int main(int argc, char *argv[])
         log_info("Profile %s loaded", cvalue);
         set_parameter_string(vmr, "command.load", 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
     {
@@ -185,15 +192,15 @@ int main(int argc, char *argv[])
     }
 
     rep = logout(vmr);
-    if (rep == 0)
+    if (rep != 0)
-    {
-        return EXIT_SUCCESS;
-    }
-    else
     {
         log_fatal("Error logging out of the Voicemeeter API");
         return EXIT_FAILURE;
     }
+    else
+    {
+        return EXIT_SUCCESS;
+    }
 }
 
 /**
@@ -230,27 +237,32 @@ 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)
+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;
-        if (strlen(input) == 1 && toupper(input[0]) == 'Q')
+        if ((len = strlen(input)) == 1 && toupper(input[0]) == 'Q')
             break;
 
         parse_input(vmr, input);
+        memset(input, 0, len); /* reset input buffer */
 
-        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
@@ -258,13 +270,16 @@ void interactive(PT_VMR vmr)
  */
 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);
     }
 }
 
@@ -280,6 +295,24 @@ 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++;
@@ -340,7 +373,7 @@ void parse_command(PT_VMR vmr, char *command)
  */
 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.9.0
  * @date 2024-07-06
  *
  * @copyright Copyright (c) 2024
@@ -18,6 +18,7 @@
 
 #define KIND_STR_LEN 64
 #define VERSION_STR_LEN 32
+#define LOGIN_TIMEOUT 2
 
 /**
  * @brief Logs into the API.
@@ -30,7 +31,7 @@
  */
 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
     {
@@ -57,11 +57,11 @@ long login(PT_VMR vmr, int kind)
             break;
         }
         Sleep(50);
-    } while (time(NULL) < start + timeout);
+    } while (difftime(time(NULL), start) < LOGIN_TIMEOUT);
 
     if (rep == 0)
     {
-        clear_dirty(vmr);
+        clear(vmr, is_pdirty);
     }
     return rep;
 }
@@ -75,7 +75,7 @@ long login(PT_VMR vmr, int kind)
  */
 long logout(PT_VMR vmr)
 {
-    int rep;
+    long rep;
 
     Sleep(20); /* give time for last command */
     log_trace("VBVMR_Logout()");
@@ -156,10 +156,3 @@ 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)
-{
-    Sleep(30);
-    while (is_pdirty(vmr))
-        Sleep(1);
-}