minor ver bump

log timeout if login() returns -2

make functions in this module static. They aren't expected to be called elsewhere

.gitignore

@@ -52,3 +52,5 @@ Mkfile.old
 dkms.conf
 
 .vscode/
+
+test*

README.md

@@ -48,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:

include/util.h

@@ -8,9 +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__ */

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.8.0
+ * @version 0.10.0
  * @date 2024-07-06
  *
  * @copyright Vincent Burel(c)2015-2021 All Rights Reserved
@@ -13,8 +13,6 @@
  * https://github.com/onyx-and-iris/vmrcli/blob/main/LICENSE
  */
 
-#include <stdbool.h>
-#include <stdio.h>
 #include <windows.h>
 #include "ivmr.h"
 #include "util.h"
@@ -36,6 +34,7 @@ static bool registry_get_voicemeeter_folder(char *szDir);
  * @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()
 {
@@ -48,13 +47,12 @@ PT_VMR create_interface()
         if (rep == -100)
         {
             log_fatal("Voicemeeter is not installed");
-            exit(EXIT_FAILURE);
         }
         else
         {
-            log_fatal("Error loading Voicemeeter dll with code %d\n", rep);
-            exit(EXIT_FAILURE);
+            log_fatal("Error loading Voicemeeter dll with code %d", rep);
         }
+        return NULL;
     }
 
     return vmr;

src/util.c

@@ -2,24 +2,21 @@
  * @file util.c
  * @author Onyx and Iris (code@onyxandiris.online)
  * @brief Utility functions.
- * @version 0.8.0
+ * @version 0.10.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
@@ -82,3 +79,25 @@ 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.8.0
+ * @version 0.10.0
  * @date 2024-07-06
  *
  * @copyright Copyright (c) 2024
@@ -11,10 +11,7 @@
 
 #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 "wrapper.h"
@@ -32,38 +29,43 @@
               "\tm: Launch the MacroButtons application\n"                                       \
               "\ts: Launch the StreamerView application"
 #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);
-enum kind set_kind(char *kval);
-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);
+static void usage();
+static enum kind set_kind(char *kval);
+static void interactive(PT_VMR vmr, bool with_prompt);
+static void parse_input(PT_VMR vmr, char *input);
+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[])
 {
@@ -147,32 +149,39 @@ int main(int argc, char *argv[])
     }
 
     PT_VMR vmr = create_interface();
+    if (vmr == NULL)
+    {
+        exit(EXIT_FAILURE);
+    }
 
     long rep = login(vmr, kind);
     if (rep != 0)
     {
-        log_fatal("Error logging into the Voicemeeter API");
+        if (rep == -2)
+            log_fatal("Timeout logging into the API.");
+        else
+            log_fatal("Eror logging into the Voicemeeter API");
         exit(EXIT_FAILURE);
     }
 
     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)
@@ -196,12 +205,13 @@ int main(int argc, char *argv[])
     }
     else
     {
+        log_info("Successfully logged out of the Voicemeeter API");
         return EXIT_SUCCESS;
     }
 }
 
 /**
- * @brief prints the help message
+ * @brief Prints the help message
  */
 static void usage()
 {
@@ -216,7 +226,7 @@ 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;
@@ -234,22 +244,24 @@ 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, bool with_prompt)
+static void interactive(PT_VMR vmr, bool with_prompt)
 {
     char input[MAX_LINE];
+    size_t len;
 
     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(">> ");
     }
@@ -263,18 +275,18 @@ void interactive(PT_VMR vmr, bool with_prompt)
  * @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);
     }
 }
 
@@ -286,10 +298,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++;
@@ -346,11 +376,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.8.0
+ * @version 0.10.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,7 +25,9 @@
  *
  * @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)
 {
@@ -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)
 {
-    long rep;
-
     Sleep(20); /* give time for last command */
     log_trace("VBVMR_Logout()");
-    rep = vmr->VBVMR_Logout();
-    if (rep == 0)
-        log_info("Successfully logged out of the Voicemeeter API");
-    return rep;
+    return vmr->VBVMR_Logout();
 }
 
+/**
+ * @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);
 }