log fatal exit points

replace fallthrough comment with fallthrough attribute

README.md

@@ -13,7 +13,7 @@
 ## `Use`
 
 ```powershell
-./vmrcli.exe [-h] [-i] [-k] [-D] [-v] [-c] [-m] [-s] <api commands>
+.\vmrcli.exe [-h] [-i] [-k] [-D] [-v] [-c] [-m] [-s] <api commands>
 ```
 
 Where:
@@ -38,13 +38,13 @@ Examples:
 Launch basic GUI, set log level to INFO, Toggle Strip 0 Mute, print its new value, then decrease Bus 0 Gain by 3.8
 
 ```powershell
-./vmrcli.exe -kbasic -D2 !strip[0].mute strip[0].mute bus[0].gain-=3.8
+.\vmrcli.exe -kbasic -D2 !strip[0].mute strip[0].mute bus[0].gain-=3.8
 ```
 
 Launch banana GUI, set log level to DEBUG, set Strip 0 label to podmic then print Strip 2 label
 
 ```powershell
-./vmrcli.exe -kbanana -D1 strip[0].label=podmic strip[2].label
+.\vmrcli.exe -kbanana -D1 strip[0].label=podmic strip[2].label
 ```
 
 ## `Interactive Mode`
@@ -52,7 +52,7 @@ Launch banana GUI, set log level to DEBUG, set Strip 0 label to podmic then prin
 Running the following command in Powershell:
 
 ```powershell
-./vmrcli.exe -i
+.\vmrcli.exe -i
 ```
 
 Will open an interactive prompt:
@@ -69,10 +69,16 @@ API commands follow the same rules as listed above. Entering `Q` or `q` will exi
 Scripts can be loaded from text files, for example in Powershell:
 
 ```powershell
-./vmrcli.exe -D1 $(Get-Content .\example_commands.txt)
+.\vmrcli.exe -D1 $(Get-Content .\example_commands.txt)
 ```
 
-Multiple API commands can be in a single line but they should be space separated.
+You may also pipe a scripts contents to the CLI:
+
+```powershell
+$(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 `,`.
 
 ## `Build`
 

include/VoicemeeterRemote.h

@@ -687,43 +687,43 @@ extern "C"
 	/*                          'C' STRUCTURED INTERFACE                          */
 	/******************************************************************************/
 
-	typedef long long(__stdcall *T_VBVMR_Login)(void);
+	typedef long(__stdcall *T_VBVMR_Login)(void);
-	typedef long long(__stdcall *T_VBVMR_Logout)(void);
+	typedef long(__stdcall *T_VBVMR_Logout)(void);
-	typedef long long(__stdcall *T_VBVMR_RunVoicemeeter)(long vType);
+	typedef long(__stdcall *T_VBVMR_RunVoicemeeter)(long vType);
 
-	typedef long long(__stdcall *T_VBVMR_GetVoicemeeterType)(long *pType);
+	typedef long(__stdcall *T_VBVMR_GetVoicemeeterType)(long *pType);
-	typedef long long(__stdcall *T_VBVMR_GetVoicemeeterVersion)(long *pVersion);
+	typedef long(__stdcall *T_VBVMR_GetVoicemeeterVersion)(long *pVersion);
 
-	typedef long long(__stdcall *T_VBVMR_IsParametersDirty)(void);
+	typedef long(__stdcall *T_VBVMR_IsParametersDirty)(void);
-	typedef long long(__stdcall *T_VBVMR_GetParameterFloat)(char *szParamName, float *pValue);
+	typedef long(__stdcall *T_VBVMR_GetParameterFloat)(char *szParamName, float *pValue);
-	typedef long long(__stdcall *T_VBVMR_GetParameterStringA)(char *szParamName, char *szString);
+	typedef 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_GetParameterStringW)(char *szParamName, unsigned short *wszString);
 
-	typedef long long(__stdcall *T_VBVMR_GetLevel)(long nType, long nuChannel, float *pValue);
+	typedef 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(__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_SendMidiMessage)(unsigned char *pMIDIBuffer, long nbByteMax);
 
-	typedef long long(__stdcall *T_VBVMR_SetParameterFloat)(char *szParamName, float Value);
+	typedef long(__stdcall *T_VBVMR_SetParameterFloat)(char *szParamName, float Value);
-	typedef long long(__stdcall *T_VBVMR_SetParameters)(char *szParamScript);
+	typedef long(__stdcall *T_VBVMR_SetParameters)(char *szParamScript);
-	typedef long long(__stdcall *T_VBVMR_SetParametersW)(unsigned short *szParamScript);
+	typedef long(__stdcall *T_VBVMR_SetParametersW)(unsigned short *szParamScript);
-	typedef long long(__stdcall *T_VBVMR_SetParameterStringA)(char *szParamName, char *szString);
+	typedef 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_SetParameterStringW)(char *szParamName, unsigned short *wszString);
 
-	typedef long long(__stdcall *T_VBVMR_Output_GetDeviceNumber)(void);
+	typedef 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(__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(__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(__stdcall *T_VBVMR_Input_GetDeviceNumber)(void);
-	typedef long long(__stdcall *T_VBVMR_Input_GetDeviceDescA)(long zindex, long *nType, char *szDeviceName, char *szHardwareId);
+	typedef 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_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(__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(__stdcall *T_VBVMR_AudioCallbackStart)(void);
-	typedef long long(__stdcall *T_VBVMR_AudioCallbackStop)(void);
+	typedef long(__stdcall *T_VBVMR_AudioCallbackStop)(void);
-	typedef long long(__stdcall *T_VBVMR_AudioCallbackUnregister)(void);
+	typedef long(__stdcall *T_VBVMR_AudioCallbackUnregister)(void);
 
-	typedef long long(__stdcall *T_VBVMR_MacroButton_IsDirty)(void);
+	typedef long(__stdcall *T_VBVMR_MacroButton_IsDirty)(void);
-	typedef long long(__stdcall *T_VBVMR_MacroButton_GetStatus)(long nuLogicalButton, float *pValue, long bitmode);
+	typedef 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_SetStatus)(long nuLogicalButton, float fValue, long bitmode);
 
 	typedef struct tagVBVMR_INTERFACE
 	{

include/util.h

@@ -8,9 +8,8 @@
 #ifndef __UTIL_H__
 #define __UTIL_H__
 
-void remove_name_in_path(char *szPath);
+void remove_last_part_of_path(char *fullpath);
-int replace_multiple_space_with_one(char *s, size_t len);
 char *kind_as_string(char *s, int kind, int n);
-char *version_as_string(char *, long v, int n);
+char *version_as_string(char *s, long v, int n);
 
 #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
 

src/ivmr.c

@@ -3,13 +3,13 @@
  * @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.5.0
+ * @version 0.7.0
  * @date 2024-07-06
  *
  * @copyright Vincent Burel(c)2015-2021 All Rights Reserved
- * https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/main/LICENSE
+ * https://github.com/vburel2018/Voicemeeter-SDK/blob/main/LICENSE
  *
- * Copyright (c) 2024
+ * Copyright (c) 2024 Onyx and Iris
  * https://github.com/onyx-and-iris/vmrcli/blob/main/LICENSE
  */
 
@@ -211,7 +211,7 @@ static bool registry_get_voicemeeter_folder(char *szDir)
     if (rep != ERROR_SUCCESS)
         return false;
     // remove name to get the path only
-    remove_name_in_path(sss);
+    remove_last_part_of_path(sss);
     if (nnsize > 512)
         nnsize = 512;
     strncpy(szDir, sss, nnsize);

src/util.c

@@ -2,7 +2,7 @@
  * @file util.c
  * @author Onyx and Iris (code@onyxandiris.online)
  * @brief Utility functions.
- * @version 0.5.0
+ * @version 0.7.0
  * @date 2024-07-06
  *
  * @copyright Copyright (c) 2024
@@ -11,66 +11,24 @@
 
 #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 szPath Pointer to the path string
+ * @param fullpath The entire path
  */
-void remove_name_in_path(char *szPath)
+void remove_last_part_of_path(char *fullpath)
 {
-    char *p = szPath;
+    char *p;
 
-    while (*p++)
+    if ((p = strrchr(fullpath, '\\')) != NULL)
-        ;
+    {
-    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;
-
-    if (len == 1 && (s[0] == ' ' || s[0] == '\t'))
-    {
-        s[0] = '\0';
-        return len;
-    }
-
-    if (len < 2)
-        return len;
-
-    for (int i = 0; s[i] != '\0'; i++)
-    {
-        if (s[i] == ' ' || s[i] == '\t')
-        {
-            count++;
-        }
-
-        if (s[i] != ' ' && s[i] != '\t')
-        {
-            if (count >= 1)
-            {
-                count = 0;
-                s[j++] = ' ';
-            }
-            s[j++] = s[i];
-        }
-    }
-    s[j] = '\0';
-    return j;
 }
 
 /**

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.5.0
+ * @version 0.7.0
  * @date 2024-07-06
  *
  * @copyright Copyright (c) 2024
@@ -15,11 +15,23 @@
 #include <getopt.h>
 #include <string.h>
 #include <ctype.h>
+#include <windows.h>
 #include "ivmr.h"
 #include "wrapper.h"
 #include "log.h"
 #include "util.h"
 
+#define USAGE "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"
+#define OPTSTR ":hk:msc:iD:v"
 #define MAX_LINE 512
 
 /**
@@ -46,10 +58,10 @@ 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 parse_input(PT_VMR vmr, char *input, int len);
+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);
 
@@ -66,19 +78,16 @@ int main(int argc, char *argv[])
 
     if (argc == 1)
     {
-        help();
+        usage();
-        exit(EXIT_SUCCESS);
     }
 
     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)
@@ -116,8 +125,20 @@ 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();
         }
     }
 
@@ -146,6 +167,8 @@ int main(int argc, char *argv[])
     {
         log_info("Profile %s loaded", cvalue);
         set_parameter_string(vmr, "command.load", cvalue);
+        Sleep(300);
+        clear_dirty(vmr);
     }
 
     if (iflag)
@@ -157,7 +180,7 @@ int main(int argc, char *argv[])
     {
         for (int i = optind; i < argc; i++)
         {
-            parse_input(vmr, argv[i], strlen(argv[i]));
+            parse_input(vmr, argv[i]);
         }
     }
 
@@ -176,19 +199,10 @@ int main(int argc, char *argv[])
 /**
  * @brief prints the help message
  */
-void help()
+static void usage()
 {
-    puts(
+    puts(USAGE);
-        "Usage: ./vmrcli.exe [-h] [-i] [-k] [-D] [-v] [-c] [-m] [-s] <api commands>\n"
+    exit(EXIT_SUCCESS);
-        "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");
 }
 
 /**
@@ -201,31 +215,14 @@ void help()
 enum kind set_kind(char *kval)
 {
     if (strcmp(kval, "basic") == 0)
-    {
+        return sizeof(void *) == 8 ? BASICX64 : BASIC;
-        if (sizeof(void *) == 8)
-            return BASICX64;
-        else
-            return BASIC;
-    }
     else if (strcmp(kval, "banana") == 0)
-    {
+        return sizeof(void *) == 8 ? BANANAX64 : BANANA;
-        if (sizeof(void *) == 8)
-            return BANANAX64;
-        else
-            return BANANA;
-    }
     else if (strcmp(kval, "potato") == 0)
-    {
+        return sizeof(void *) == 8 ? POTATOX64 : POTATO;
-        if (sizeof(void *) == 8)
-            return POTATOX64;
     else
-            return POTATO;
-    }
-    else
-    {
         return UNKNOWN;
 }
-}
 
 /**
  * @brief Continuously read lines from stdin.
@@ -237,41 +234,37 @@ enum kind set_kind(char *kval)
 void interactive(PT_VMR vmr)
 {
     char input[MAX_LINE];
-    size_t len;
 
     printf(">> ");
     while (fgets(input, MAX_LINE, stdin) != NULL)
     {
         input[strcspn(input, "\n")] = 0;
-        len = strlen(input);
+        if (strlen(input) == 1 && toupper(input[0]) == 'Q')
-        if (len == 1 && toupper(input[0]) == 'Q')
             break;
 
-        parse_input(vmr, input, len);
+        parse_input(vmr, input);
 
-        memset(input, '\0', MAX_LINE); /* reset input buffer */
+        memset(input, 0, MAX_LINE); /* reset input buffer */
         printf(">> ");
     }
 }
 
 /**
- * @brief Walks through each line split by a space delimiter.
+ * @brief Walks through each line split by " \t;," delimiters.
  * Each token is passed to parse_command()
  *
  * @param vmr Pointer to the iVMR interface
  * @param input Each input line, from stdin or CLI args
- * @param len The length of the input line
  */
-void parse_input(PT_VMR vmr, char *input, int len)
+void parse_input(PT_VMR vmr, char *input)
 {
-    char *token;
+    char *token, *p;
 
-    replace_multiple_space_with_one(input, len);
+    token = strtok_r(input, " \t;,", &p);
-    token = strtok(input, " ");
     while (token != NULL)
     {
         parse_command(vmr, token);
-        token = strtok(NULL, " ");
+        token = strtok_r(NULL, " \t;,", &p);
     }
 }
 
@@ -328,6 +321,7 @@ void parse_command(PT_VMR vmr, char *command)
             printf("%s: %.1f\n", command, res.val.f);
             break;
         case STRING_T:
+            if (res.val.s[0] != '\0')
                 printf("%s: %ls\n", command, res.val.s);
             break;
         default:
@@ -337,7 +331,8 @@ void parse_command(PT_VMR vmr, char *command)
 }
 
 /**
- * @brief
+ * @brief Get the value of a float or string parameter.
+ * Stores its type and value into a result struct
  *
  * @param vmr Pointer to the iVMR interface
  * @param command A parsed 'get' command as a string

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.5.0
+ * @version 0.7.0
  * @date 2024-07-06
  *
  * @copyright Copyright (c) 2024