add -I flag for disabling >> on the interactive prompt

return early from parse_input() if input is a comment

add comments to example_commands.txt

upd README.

minor ver bump

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)
@@ -75,10 +76,12 @@ 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 delimited by space, `;` or `,`.
+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`
 

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

@@ -687,43 +687,43 @@ extern "C"
 	/*                          'C' STRUCTURED INTERFACE                          */
 	/******************************************************************************/
 
-	typedef long long(__stdcall *T_VBVMR_Login)(void);
-	typedef long long(__stdcall *T_VBVMR_Logout)(void);
-	typedef long long(__stdcall *T_VBVMR_RunVoicemeeter)(long vType);
+	typedef long(__stdcall *T_VBVMR_Login)(void);
+	typedef long(__stdcall *T_VBVMR_Logout)(void);
+	typedef long(__stdcall *T_VBVMR_RunVoicemeeter)(long vType);
 
-	typedef long long(__stdcall *T_VBVMR_GetVoicemeeterType)(long *pType);
-	typedef long long(__stdcall *T_VBVMR_GetVoicemeeterVersion)(long *pVersion);
+	typedef long(__stdcall *T_VBVMR_GetVoicemeeterType)(long *pType);
+	typedef long(__stdcall *T_VBVMR_GetVoicemeeterVersion)(long *pVersion);
 
-	typedef long long(__stdcall *T_VBVMR_IsParametersDirty)(void);
-	typedef long long(__stdcall *T_VBVMR_GetParameterFloat)(char *szParamName, float *pValue);
-	typedef long long(__stdcall *T_VBVMR_GetParameterStringA)(char *szParamName, char *szString);
-	typedef long long(__stdcall *T_VBVMR_GetParameterStringW)(char *szParamName, unsigned short *wszString);
+	typedef long(__stdcall *T_VBVMR_IsParametersDirty)(void);
+	typedef long(__stdcall *T_VBVMR_GetParameterFloat)(char *szParamName, float *pValue);
+	typedef long(__stdcall *T_VBVMR_GetParameterStringA)(char *szParamName, char *szString);
+	typedef long(__stdcall *T_VBVMR_GetParameterStringW)(char *szParamName, unsigned short *wszString);
 
-	typedef long long(__stdcall *T_VBVMR_GetLevel)(long nType, long nuChannel, float *pValue);
-	typedef long long(__stdcall *T_VBVMR_GetMidiMessage)(unsigned char *pMIDIBuffer, long nbByteMax);
-	typedef long long(__stdcall *T_VBVMR_SendMidiMessage)(unsigned char *pMIDIBuffer, long nbByteMax);
+	typedef long(__stdcall *T_VBVMR_GetLevel)(long nType, long nuChannel, float *pValue);
+	typedef long(__stdcall *T_VBVMR_GetMidiMessage)(unsigned char *pMIDIBuffer, long nbByteMax);
+	typedef long(__stdcall *T_VBVMR_SendMidiMessage)(unsigned char *pMIDIBuffer, long nbByteMax);
 
-	typedef long long(__stdcall *T_VBVMR_SetParameterFloat)(char *szParamName, float Value);
-	typedef long long(__stdcall *T_VBVMR_SetParameters)(char *szParamScript);
-	typedef long long(__stdcall *T_VBVMR_SetParametersW)(unsigned short *szParamScript);
-	typedef long long(__stdcall *T_VBVMR_SetParameterStringA)(char *szParamName, char *szString);
-	typedef long long(__stdcall *T_VBVMR_SetParameterStringW)(char *szParamName, unsigned short *wszString);
+	typedef long(__stdcall *T_VBVMR_SetParameterFloat)(char *szParamName, float Value);
+	typedef long(__stdcall *T_VBVMR_SetParameters)(char *szParamScript);
+	typedef long(__stdcall *T_VBVMR_SetParametersW)(unsigned short *szParamScript);
+	typedef long(__stdcall *T_VBVMR_SetParameterStringA)(char *szParamName, char *szString);
+	typedef long(__stdcall *T_VBVMR_SetParameterStringW)(char *szParamName, unsigned short *wszString);
 
-	typedef long long(__stdcall *T_VBVMR_Output_GetDeviceNumber)(void);
-	typedef long long(__stdcall *T_VBVMR_Output_GetDeviceDescA)(long zindex, long *nType, char *szDeviceName, char *szHardwareId);
-	typedef long long(__stdcall *T_VBVMR_Output_GetDeviceDescW)(long zindex, long *nType, unsigned short *wszDeviceName, unsigned short *wszHardwareId);
-	typedef long long(__stdcall *T_VBVMR_Input_GetDeviceNumber)(void);
-	typedef long long(__stdcall *T_VBVMR_Input_GetDeviceDescA)(long zindex, long *nType, char *szDeviceName, char *szHardwareId);
-	typedef long long(__stdcall *T_VBVMR_Input_GetDeviceDescW)(long zindex, long *nType, unsigned short *wszDeviceName, unsigned short *wszHardwareId);
+	typedef long(__stdcall *T_VBVMR_Output_GetDeviceNumber)(void);
+	typedef long(__stdcall *T_VBVMR_Output_GetDeviceDescA)(long zindex, long *nType, char *szDeviceName, char *szHardwareId);
+	typedef long(__stdcall *T_VBVMR_Output_GetDeviceDescW)(long zindex, long *nType, unsigned short *wszDeviceName, unsigned short *wszHardwareId);
+	typedef long(__stdcall *T_VBVMR_Input_GetDeviceNumber)(void);
+	typedef long(__stdcall *T_VBVMR_Input_GetDeviceDescA)(long zindex, long *nType, char *szDeviceName, char *szHardwareId);
+	typedef long(__stdcall *T_VBVMR_Input_GetDeviceDescW)(long zindex, long *nType, unsigned short *wszDeviceName, unsigned short *wszHardwareId);
 
-	typedef long long(__stdcall *T_VBVMR_AudioCallbackRegister)(long mode, T_VBVMR_VBAUDIOCALLBACK pCallback, void *lpUser, char szClientName[64]);
-	typedef long long(__stdcall *T_VBVMR_AudioCallbackStart)(void);
-	typedef long long(__stdcall *T_VBVMR_AudioCallbackStop)(void);
-	typedef long long(__stdcall *T_VBVMR_AudioCallbackUnregister)(void);
+	typedef long(__stdcall *T_VBVMR_AudioCallbackRegister)(long mode, T_VBVMR_VBAUDIOCALLBACK pCallback, void *lpUser, char szClientName[64]);
+	typedef long(__stdcall *T_VBVMR_AudioCallbackStart)(void);
+	typedef long(__stdcall *T_VBVMR_AudioCallbackStop)(void);
+	typedef long(__stdcall *T_VBVMR_AudioCallbackUnregister)(void);
 
-	typedef long long(__stdcall *T_VBVMR_MacroButton_IsDirty)(void);
-	typedef long long(__stdcall *T_VBVMR_MacroButton_GetStatus)(long nuLogicalButton, float *pValue, long bitmode);
-	typedef long long(__stdcall *T_VBVMR_MacroButton_SetStatus)(long nuLogicalButton, float fValue, long bitmode);
+	typedef long(__stdcall *T_VBVMR_MacroButton_IsDirty)(void);
+	typedef long(__stdcall *T_VBVMR_MacroButton_GetStatus)(long nuLogicalButton, float *pValue, long bitmode);
+	typedef long(__stdcall *T_VBVMR_MacroButton_SetStatus)(long nuLogicalButton, float fValue, long bitmode);
 
 	typedef struct tagVBVMR_INTERFACE
 	{

include/util.h

@@ -11,5 +11,6 @@
 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);
 
 #endif /* __UTIL_H__ */

makefile

@@ -15,7 +15,7 @@ ifeq ($(LOG_USE_COLOR), yes)
 else
 	CPPFLAGS := -Iinclude -MMD -MP
 endif
-CFLAGS = -O -Wall -W -pedantic -ansi -std=c99
+CFLAGS = -O -Wall -W -pedantic -ansi -std=c2x
 LDFLAGS  := -Llib
 LDLIBS   := -lm
 
@@ -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.6.0
+ * @version 0.8.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.6.0
+ * @version 0.8.0
  * @date 2024-07-06
  *
  * @copyright Copyright (c) 2024
@@ -70,3 +70,15 @@ char *version_as_string(char *s, long v, int n)
     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] == '#';
+}

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.6.0
+ * @version 0.8.0
  * @date 2024-07-06
  *
  * @copyright Copyright (c) 2024
@@ -21,6 +21,17 @@
 #include "log.h"
 #include "util.h"
 
+#define USAGE "Usage: .\\vmrcli.exe [-h] [-i|-I] [-k] [-D] [-v] [-c] [-m] [-s] <api commands>\n" \
+              "Where: \n"                                                                        \
+              "\th: Prints the help message\n"                                                   \
+              "\ti: Enable interactive mode, use (-I) to disable the '>>' prompt\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"          \
+              "\tv: Enable extra console output (toggle, set messages)\n"                        \
+              "\tc: Load a user configuration (give the full file path)\n"                       \
+              "\tm: Launch the MacroButtons application\n"                                       \
+              "\ts: Launch the StreamerView application"
+#define OPTSTR ":hk:msc:iID:v"
 #define MAX_LINE 512
 
 /**
@@ -47,9 +58,9 @@ struct result
 
 static bool vflag = false;
 
-void help(void);
+static void usage(void);
 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);
@@ -59,7 +70,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;
@@ -67,19 +79,16 @@ int main(int argc, char *argv[])
 
     if (argc == 1)
     {
-        help();
-        exit(EXIT_SUCCESS);
+        usage();
     }
 
     log_set_level(LOG_WARN);
 
-    while ((opt = getopt(argc, argv, "hk:msc:iD:v")) != -1)
+    opterr = 0;
+    while ((opt = getopt(argc, argv, OPTSTR)) != -1)
     {
         switch (opt)
         {
-        case 'h':
-            help();
-            exit(EXIT_SUCCESS);
         case 'k':
             kind = set_kind(optarg);
             if (kind == UNKNOWN)
@@ -98,6 +107,9 @@ int main(int argc, char *argv[])
             cflag = true;
             cvalue = optarg;
             break;
+        case 'I':
+            with_prompt = false;
+            [[fallthrough]];
         case 'i':
             iflag = true;
             break;
@@ -117,14 +129,26 @@ int main(int argc, char *argv[])
         case 'v':
             vflag = true;
             break;
+        case '?':
+            log_fatal("unknown option -- '%c'\n"
+                      "Try .\\vmrcli.exe -h for more information.",
+                      optopt);
+            exit(EXIT_FAILURE);
+        case ':':
+            log_fatal("missing argument for option -- '%c'\n"
+                      "Try .\\vmrcli.exe -h for more information.",
+                      optopt);
+            exit(EXIT_FAILURE);
+        case 'h':
+            [[fallthrough]];
         default:
-            abort();
+            usage();
         }
     }
 
     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");
@@ -154,7 +178,7 @@ int main(int argc, char *argv[])
     if (iflag)
     {
         puts("Interactive mode enabled. Enter 'Q' to exit.");
-        interactive(vmr);
+        interactive(vmr, with_prompt);
     }
     else
     {
@@ -165,33 +189,24 @@ int main(int argc, char *argv[])
     }
 
     rep = logout(vmr);
-    if (rep == 0)
-    {
-        return EXIT_SUCCESS;
-    }
-    else
+    if (rep != 0)
     {
         log_fatal("Error logging out of the Voicemeeter API");
         return EXIT_FAILURE;
     }
+    else
+    {
+        return EXIT_SUCCESS;
+    }
 }
 
 /**
  * @brief prints the help message
  */
-void help()
+static void usage()
 {
-    puts(
-        "Usage: .\\vmrcli.exe [-h] [-i] [-k] [-D] [-v] [-c] [-m] [-s] <api commands>\n"
-        "Where: \n"
-        "\th: Prints the help message\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\n"
-        "\tv: Enable extra console output (toggle, set messages)\n"
-        "\tc: Load a user configuration (give the full file path)\n"
-        "\tm: Launch the MacroButtons application\n"
-        "\ts: Launch the StreamerView application");
+    puts(USAGE);
+    exit(EXIT_SUCCESS);
 }
 
 /**
@@ -204,30 +219,13 @@ void help()
 enum kind set_kind(char *kval)
 {
     if (strcmp(kval, "basic") == 0)
-    {
-        if (sizeof(void *) == 8)
-            return BASICX64;
-        else
-            return BASIC;
-    }
+        return sizeof(void *) == 8 ? BASICX64 : BASIC;
     else if (strcmp(kval, "banana") == 0)
-    {
-        if (sizeof(void *) == 8)
-            return BANANAX64;
-        else
-            return BANANA;
-    }
+        return sizeof(void *) == 8 ? BANANAX64 : BANANA;
     else if (strcmp(kval, "potato") == 0)
-    {
-        if (sizeof(void *) == 8)
-            return POTATOX64;
-        else
-            return POTATO;
-    }
+        return sizeof(void *) == 8 ? POTATOX64 : POTATO;
     else
-    {
         return UNKNOWN;
-    }
 }
 
 /**
@@ -237,11 +235,12 @@ enum kind set_kind(char *kval)
  *
  * @param vmr Pointer to the iVMR interface
  */
-void interactive(PT_VMR vmr)
+void interactive(PT_VMR vmr, bool with_prompt)
 {
     char input[MAX_LINE];
 
-    printf(">> ");
+    if (with_prompt)
+        printf(">> ");
     while (fgets(input, MAX_LINE, stdin) != NULL)
     {
         input[strcspn(input, "\n")] = 0;
@@ -251,12 +250,14 @@ void interactive(PT_VMR vmr)
         parse_input(vmr, input);
 
         memset(input, 0, MAX_LINE); /* reset input buffer */
-        printf(">> ");
+        if (with_prompt)
+            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
@@ -264,6 +265,9 @@ 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);

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.6.0
+ * @version 0.8.0
  * @date 2024-07-06
  *
  * @copyright Copyright (c) 2024
@@ -30,7 +30,7 @@
  */
 long login(PT_VMR vmr, int kind)
 {
-    int rep;
+    long rep;
     long v;
 
     log_trace("VBVMR_Login()");
@@ -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()");