include/util.h

@@ -19,5 +19,6 @@ 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

@@ -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, wchar_t *s);
+long get_parameter_string(PT_VMR vmr, char *param, unsigned short *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,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(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.10.0
+ * @version 0.9.0
  * @date 2024-07-06
  *
  * @copyright Vincent Burel(c)2015-2021 All Rights Reserved
@@ -13,6 +13,8 @@
  * 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"
@@ -34,7 +36,6 @@ 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()
 {
@@ -47,12 +48,13 @@ 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", rep);
+            log_fatal("Error loading Voicemeeter dll with code %d\n", rep);
+            exit(EXIT_FAILURE);
         }
-        return NULL;
     }
 
     return vmr;

src/util.c

@@ -2,21 +2,25 @@
  * @file util.c
  * @author Onyx and Iris (code@onyxandiris.online)
  * @brief Utility functions.
- * @version 0.10.0
+ * @version 0.9.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 <windows.h>
+#include "wrapper.h"
 #include "util.h"
 
 /**
  * @brief Removes the last part of a path
  *
- * @param fullpath
+ * @param fullpath The entire path
  */
 void remove_last_part_of_path(char *fullpath)
 {
@@ -31,7 +35,7 @@ void remove_last_part_of_path(char *fullpath)
 /**
  * @brief Converts Voicemeeter's kind into a string.
  *
- * @param s Pointer to a character buffer receiving the kind
+ * @param s Pointer to a character buffer
  * @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.
@@ -53,7 +57,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 receiving the version
+ * @param s Pointer to a character buffer
  * @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
@@ -101,3 +105,16 @@ struct quickcommand *command_in_quickcommands(const char *command_key, const str
     }
     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.10.0
+ * @version 0.9.0
  * @date 2024-07-06
  *
  * @copyright Copyright (c) 2024
@@ -11,7 +11,10 @@
 
 #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"
@@ -44,9 +47,7 @@ enum restype : int
 };
 
 /**
- * @struct A struct used for:
+ * @struct A struct holding the result of a get call.
- * - tracking the type of value stored
- * - storing the result of a get call
  */
 struct result
 {
@@ -61,11 +62,11 @@ struct result
 static bool vflag = false;
 
 static void usage();
-static enum kind set_kind(char *kval);
+enum kind set_kind(char *kval);
-static void interactive(PT_VMR vmr, bool with_prompt);
+void interactive(PT_VMR vmr, bool with_prompt);
-static void parse_input(PT_VMR vmr, char *input);
+void parse_input(PT_VMR vmr, char *input);
-static void parse_command(PT_VMR vmr, char *command);
+void parse_command(PT_VMR vmr, char *command);
-static void get(PT_VMR vmr, char *command, struct result *res);
+void get(PT_VMR vmr, char *command, struct result *res);
 
 int main(int argc, char *argv[])
 {
@@ -149,37 +150,30 @@ 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)
     {
-        if (rep == -2)
+        log_fatal("Error logging into the Voicemeeter API");
-            log_fatal("Timeout logging into the API.");
-        else
-            log_fatal("Error logging into the Voicemeeter API");
         exit(EXIT_FAILURE);
     }
 
     if (mflag)
     {
-        run_voicemeeter(vmr, MACROBUTTONS);
         log_info("MacroButtons app launched");
+        run_voicemeeter(vmr, MACROBUTTONS);
     }
 
     if (sflag)
     {
-        run_voicemeeter(vmr, STREAMERVIEW);
         log_info("StreamerView app launched");
+        run_voicemeeter(vmr, STREAMERVIEW);
     }
 
     if (cflag)
     {
-        set_parameter_string(vmr, "command.load", cvalue);
         log_info("Profile %s loaded", cvalue);
+        set_parameter_string(vmr, "command.load", cvalue);
         Sleep(300);
         clear(vmr, is_pdirty);
     }
@@ -205,13 +199,12 @@ 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()
 {
@@ -226,7 +219,7 @@ static void usage()
  * @param kval Value of the -k flag
  * @return enum kind
  */
-static enum kind set_kind(char *kval)
+enum kind set_kind(char *kval)
 {
     if (strcmp(kval, "basic") == 0)
         return sizeof(void *) == 8 ? BASICX64 : BASIC;
@@ -246,7 +239,7 @@ static enum kind set_kind(char *kval)
  * @param vmr Pointer to the iVMR interface
  * @param with_prompt If true, prints the interactive prompt '>>'
  */
-static void interactive(PT_VMR vmr, bool with_prompt)
+void interactive(PT_VMR vmr, bool with_prompt)
 {
     char input[MAX_LINE];
     size_t len;
@@ -275,7 +268,7 @@ static 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
  */
-static void parse_input(PT_VMR vmr, char *input)
+void parse_input(PT_VMR vmr, char *input)
 {
     if (is_comment(input))
         return;
@@ -298,7 +291,7 @@ static 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
  */
-static void parse_command(PT_VMR vmr, char *command)
+void parse_command(PT_VMR vmr, char *command)
 {
     log_debug("Parsing %s", command);
 
@@ -376,9 +369,9 @@ static 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 Pointer to a struct holding the result of the API call.
+ * @param res A struct holding the result of the API call.
  */
-static void get(PT_VMR vmr, char *command, struct result *res)
+void get(PT_VMR vmr, char *command, struct result *res)
 {
     clear(vmr, is_pdirty);
     if (get_parameter_float(vmr, command, &res->val.f) != 0)

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.9.0
  * @date 2024-07-06
  *
  * @copyright Copyright (c) 2024
@@ -10,6 +10,8 @@
  */
 
 #include <windows.h>
+#include <stdio.h>
+#include <time.h>
 #include "wrapper.h"
 #include "log.h"
 #include "util.h"
@@ -25,9 +27,7 @@
  *
  * @param vmr Pointer to the iVMR interface
  * @param kind The kind of Voicemeeter Gui to launch.
- * @return long
+ * @return long VBVMR_Login return value
- *  0: OK (no error).
- * -2: Login timed out.
  */
 long login(PT_VMR vmr, int kind)
 {
@@ -54,12 +54,15 @@ 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 (difftime(time(NULL), start) < LOGIN_TIMEOUT);
 
+    if (rep == 0)
+    {
+        clear(vmr, is_pdirty);
+    }
     return rep;
 }
 
@@ -68,201 +71,88 @@ long login(PT_VMR vmr, int kind)
  * final instruction to complete.
  *
  * @param vmr Pointer to the iVMR interface
- * @return long See:
+ * @return long VBVMR_Logout return value
- * 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()");
-    return vmr->VBVMR_Logout();
+    rep = vmr->VBVMR_Logout();
+    if (rep == 0)
+        log_info("Successfully logged out of the Voicemeeter API");
+    return rep;
 }
 
-/**
- * @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, <wchar_t> *s)", param);
+    log_trace("VBVMR_GetParameterStringW(%s, <unsigned short> *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() >= 0;
+    return vmr->VBVMR_MacroButton_IsDirty() == 1;
 }
 
-/**
- * @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);
 }
-
-/**
- * @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);
-}